React is one of Facebook’s first open source projects that is both under very active development and is also being used to ship code to everybody on facebook.com. We’re still working out the kinks to make contributing to this project as easy and transparent as possible, but we’re not quite there yet. Hopefully this document makes the process for contributing clear and answers some questions that you may have.
Facebook has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.
All work on React happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.
We will do our best to keep the
master branch in good shape, with tests passing at all times. But in order to move fast, we will make API changes that your application might not be compatible with. We recommend that you use the latest stable version of React.
If you send a pull request, please do it against the
master branch. We maintain stable branches for major versions separately but we don’t accept pull requests to them directly. Instead, we cherry-pick non-breaking changes from master to the latest stable major version.
React follows semantic versioning. We release patch versions for bugfixes, minor versions for new features, and major versions for any breaking changes. When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.
We tag every pull request with a label marking whether the change should go in the next patch, minor, or a major version. We release new patch versions every few weeks, minor versions every few months, and major versions one or two times a year.
Every significant change is documented in the changelog file.
Where to Find Known Issues
We are using GitHub Issues for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist.
Reporting New Issues
The best way to get your bug fixed is to provide a reduced test case. This JSFiddle template is a great starting point.
Facebook has a bounty program for the safe disclosure of security bugs. With that in mind, please do not file public issues; go through the process outlined on that page.
How to Get in Touch
There is also an active community of React users on the Discord chat platform in case you need help with React.
Proposing a Change
If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend filing an issue. This lets us reach an agreement on your proposal before you put significant effort into it.
If you’re only fixing a bug, it’s fine to submit a pull request right away but we still recommend to file an issue detailing what you’re fixing. This is helpful in case we don’t accept that specific fix but want to keep track of the issue.
Your First Pull Request
Working on your first Pull Request? You can learn how from this free video series:
To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started.
If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.
If somebody claims an issue but doesn’t follow up for more than two weeks, it’s fine to take it over but you should still leave a comment.
Sending a Pull Request
The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation. For API changes we may need to fix our internal uses at Facebook.com, which could cause some delay. We’ll do our best to provide updates and feedback throughout the process.
Before submitting a pull request, please make sure the following is done:
- Fork the repository and create your branch from
yarnin the repository root.
- If you’ve fixed a bug or added code that should be tested, add tests!
- Ensure the test suite passes (
yarn test). Tip:
yarn test --watch TestNameis helpful in development.
yarn test-prodto test in the production environment. It supports the same options as
- If you need a debugger, run
yarn debug-test --watch TestName, open
chrome://inspect, and press “Inspect”.
- Format your code with prettier (
- Make sure your code lints (
yarn lint). Tip:
yarn lincto only check changed files.
- Run the Flow typechecks (
- If you haven’t already, complete the CLA.
Contributor License Agreement (CLA)
In order to accept your pull request, we need you to submit a CLA. You only need to do this once, so if you’ve done this for another Facebook open source project, you’re good to go. If you are submitting a pull request for the first time, just let us know that you have completed the CLA and we can cross-check with your GitHub username.
- You have Node installed at v8.0.0+ and Yarn at v1.2.0+.
- You have
gccinstalled or are comfortable installing a compiler if needed. Some of our dependencies may require a compilation step. On OS X, the Xcode Command Line Tools will cover this. On Ubuntu,
apt-get install build-essentialwill install the required packages. Similar commands should work on other Linux distros. Windows will require some additional steps, see the
node-gypinstallation instructions for details.
- You are familiar with Git.
After cloning React, run
yarn to fetch its dependencies.
Then, you can run several commands:
yarn lintchecks the code style.
yarn lincis like
yarn lintbut faster because it only checks files that differ in your branch.
yarn testruns the complete test suite.
yarn test --watchruns an interactive test watcher.
yarn test <pattern>runs tests with matching filenames.
yarn test-prodruns tests in the production environment. It supports all the same options as
yarn debug-testis just like
yarn testbut with a debugger. Open
chrome://inspectand press “Inspect”.
yarn flowruns the Flow typechecks.
yarn buildcreates a
buildfolder with all the packages.
yarn build react/index,react-dom/index --type=UMDcreates UMD builds of just React and ReactDOM.
We recommend running
yarn test (or its variations above) to make sure you don’t introduce any regressions as you work on your change. However it can be handy to try your build of React in a real project.
yarn build. This will produce pre-built bundles in
build folder, as well as prepare npm packages inside
The easiest way to try your changes is to run
yarn build react/index,react-dom/index --type=UMD and then open
fixtures/packaging/babel-standalone/dev.html. This file already uses
react.development.js from the
build folder so it will pick up your changes.
If you want to try your changes in your existing React project, you may copy
build/dist/react-dom.development.js, or any other build products into your app and use them instead of the stable version. If your project uses React from npm, you may delete
react-dom in its dependencies and use
yarn link to point them to your local
cd ~/path_to_your_react_clone/build/node_modules/react yarn link cd ~/path_to_your_react_clone/build/node_modules/react-dom yarn link cd /path/to/your/project yarn link react react-dom
Every time you run
yarn build in the React folder, the updated versions will appear in your project’s
node_modules. You can then rebuild your project to try your changes.
We still require that your pull request contains unit tests for any new functionality. This way we can ensure that we don’t break your code in the future.
We use an automatic code formatter called Prettier.
yarn prettier after making any changes to the code.
Then, our linter will catch most issues that may exist in your code.
You can check the status of your code styling by simply running
However, there are still some styles that the linter cannot pick up. If you are unsure about something, looking at Airbnb’s Style Guide will guide you in the right direction.
You may be interested in watching this short video (26 mins) which gives an introduction on how to contribute to React.
- 4:12 - Building and testing React locally
- 6:07 - Creating and sending pull requests
- 8:25 - Organizing code
- 14:43 - React npm registry
- 19:15 - Adding new React features
For a realistic overview of what it feels like to contribute to React for the first time, check out this entertaining ReactNYC talk.
Request for Comments (RFC)
Many changes, including bug fixes and documentation improvements can be implemented and reviewed via the normal GitHub pull request workflow.
Some changes though are “substantial”, and we ask that these be put through a bit of a design process and produce a consensus among the React core team.
The “RFC” (request for comments) process is intended to provide a consistent and controlled path for new features to enter the project. You can contribute by visiting the rfcs repository.
By contributing to React, you agree that your contributions will be licensed under its MIT license.
Read the next section to learn how the codebase is organized.