Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Summary: This is the first step in revamping the Contribution Guide at `/CONTRIBUTING.md`. This work will require changes to the React Native website repository, as well as the React Native GitHub wiki. For review purposes, changes to copy that exists outside of this repository will be included within a `.github/wiki` directory in this PR, but they are not intended to be part of the final PR that gets merged. [General] [Changed] - Contribution Guide Revamp Pull Request resolved: #24705 Differential Revision: D15290268 Pulled By: hramos fbshipit-source-id: b09c86738e75143fbdf2fea97ccd860da79362d2
- Loading branch information
1 parent
d5b27fc
commit a6f905f
Showing
1 changed file
with
92 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,115 @@ | ||
| # Contributing to React Native | ||
|
|
||
| We want to make contributing to this project as easy and transparent as possible. Read on to learn more about our development process and how to propose bug fixes and improvements. The [How to Contribute](https://facebook.github.io/react-native/docs/contributing.html) guide on the website goes into more detail for each of these areas. | ||
| Thank you for your interest in contributing to React Native! From commenting on and triaging issues, to reviewing and sending Pull Requests, all contributions are welcome. | ||
|
|
||
| ## Our Development Process | ||
| The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful: | ||
|
|
||
| Most changes from engineers at Facebook will sync to [GitHub](https://github.com/facebook/react-native) through a bridge with Facebook's internal source control. Changes from the community are handled through GitHub pull requests. Once a change made on GitHub is approved, it will first be imported into Facebook's internal source control. The change will eventually sync back to GitHub as a single commit once it has passed Facebook's internal tests. | ||
| * [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) | ||
| * [Building Welcoming Communities](https://opensource.guide/building-community/) | ||
|
|
||
| ## Pull Requests | ||
| ### [Code of Conduct](https://code.fb.com/codeofconduct/) | ||
|
|
||
| Please make sure the following is done when submitting a pull request: | ||
| As a reminder, all contributors are expected to adhere to the [Code of Conduct](https://code.facebook.com/codeofconduct). | ||
|
|
||
| 1. Fork the repo and create your branch from `master`. | ||
| 2. If you've added code that should be tested, add tests. | ||
| 3. If you've changed APIs, update the documentation. | ||
| 4. Ensure the test suite passes. | ||
| 5. Make sure your code lints. | ||
| 6. If you haven't already, complete the Contributor License Agreement ("CLA"). | ||
|
|
||
| ## Contributor License Agreement ("CLA") | ||
| ## Ways to Contribute | ||
|
|
||
| If you are eager to start contributing code right away, we have a list of [good first issues](https://github.com/facebook/react-native/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. As you gain more experience and demonstrate a commitment to evolving React Native, you may be granted issue management permissions in the repository. | ||
|
|
||
| There are other ways you can contribute without writing a single line of code. Here are a few things you can do to help out: | ||
|
|
||
|
|
||
| 1. **Replying and handling open issues.** We get a lot of issues every day, and some of them may lack necessary information. You can help out by guiding people through the process of filling out the issue template, asking for clarifying information, or pointing them to existing issues that match their description of the problem. We'll cover more about this process later, in [Handling Issues](http://github.com/facebook/react-native/wiki/Handling-Issues). | ||
| 2. **Reviewing pull requests for the docs.** Reviewing [documentation updates](https://github.com/facebook/react-native-website/pulls) can be as simple as checking for spelling and grammar. If you encounter situations that can be explained better in the docs, click **Edit** at the top of most docs pages to get started with your own contribution. | ||
| 3. **Help people write test plans.** Some pull requests sent to the main repository may lack a proper test plan. These help reviewers understand how the change was tested, and can speed up the time it takes for a contribution to be accepted. | ||
|
|
||
|
|
||
| Each of these tasks is highly impactful, and maintainers will greatly appreciate your help. | ||
|
|
||
|
|
||
| ### Our Development Process | ||
|
|
||
| We use GitHub issues and pull requests to keep track of bug reports and contributions from the community. All changes from engineers at Facebook will sync to [GitHub](https://github.com/facebook/react-native) through a bridge with Facebook's internal source control. Changes from the community are handled through GitHub pull requests. Once a change made on GitHub is approved, it will first be imported into Facebook's internal source control and tested against Facebook's codebase. Once merged at Facebook, the change will eventually sync back to GitHub as a single commit once it has passed Facebook's internal tests. | ||
|
|
||
| You can learn more about the contribution process in the following documents: | ||
|
|
||
| * [Pull Requests](https://github.com/facebook/react-native/wiki/Pull-Requests) | ||
|
|
||
| We also have a thriving community of contributors who would be happy to help you get set up. You can reach out to us through [@ReactNative](http://twitter.com/reactnative) (the React Native team) and [@ReactNativeComm](http://twitter.com/reactnativecomm) (the React Native Community organization). | ||
|
|
||
| ### Repositories | ||
|
|
||
| The main repository, <https://github.com/facebook/react-native>, contains the React Native framework itself and it is here where we keep track of bug reports and manage pull requests. | ||
|
|
||
| There are a few other repositories you might want to familiarize yourself with: | ||
|
|
||
| * **React Native website** which contains the source code for the website, including the documentation, located at <https://github.com/facebook/react-native-website> | ||
| * **Releases** are coordinated through the <https://github.com/react-native-community/react-native-releases> repository. This includes important documents such as the Changelog. | ||
| * **Discussions** about the future of React Native take place in the <https://github.com/react-native-community/discussions-and-proposals> repository. | ||
| * **High-quality plugins** for React Native can be found throughout the [React Native Community GitHub Organization](http://github.com/react-native-community/). | ||
|
|
||
| In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects. | ||
| Browsing through these repositories should provide some insight into how the React Native open source project is managed. | ||
|
|
||
| Complete your CLA here: <https://code.facebook.com/cla> | ||
|
|
||
| ## Issues | ||
| ## Handling Issues | ||
|
|
||
| We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. | ||
| We use GitHub issues to track bugs exclusively. You can report an issue by filing a [Bug Report](https://github.com/facebook/react-native/issues/new/choose). Watch this space for more details on how to get involved and triage issues. | ||
|
|
||
| ### Security Bugs | ||
|
|
||
| Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue. | ||
|
|
||
| ## Coding Style | ||
| ## Helping with Documentation | ||
|
|
||
| The React Native documentation is hosted as part of the React Native website repository at https://github.com/facebook/react-native-website. The website itself is located at https://facebook.github.io/react-native and it is built using [Docusaurus](https://docusaurus.io/). If there's anything you'd like to change in the docs, you can get started by clicking on the "Edit" button located on the upper right of most pages in the website. | ||
|
|
||
| If you are adding new functionality or introducing a change in behavior, we will ask you to update the documentation to reflect your changes. | ||
|
|
||
| ### Contributing to the Blog | ||
|
|
||
| The React Native blog is generated [from the Markdown sources for the blog](https://github.com/facebook/react-native-website/tree/master/website/blog). | ||
|
|
||
| Please open an issue in the `react-native-website` repository or tag us on [@ReactNative on Twitter](http://twitter.com/reactnative) and get the go-ahead from a maintainer before writing an article intended for the React Native blog. In most cases, you might want to share your article on your own blog or writing medium instead. It's worth asking, though, in case we find your article is a good fit for the blog. | ||
|
|
||
| We recommend referring to the [CONTRIBUTING](https://github.com/facebook/react-native-website/blob/master/CONTRIBUTING.md) document for the `react-native-website` repository to learn more about contributing to the website in general. | ||
|
|
||
|
|
||
| ## Contributing Code | ||
|
|
||
| Code-level contributions to React Native generally come in the form of [pull requests](https://help.github.com/en/articles/about-pull-requests). The process of proposing a change to React Native can be summarized as follows: | ||
|
|
||
| 1. Fork the React Native repository and create your branch from `master`. | ||
| 2. If you've added code that should be tested, add tests. | ||
| 3. If you've changed APIs, update the documentation. | ||
| 4. Ensure the test suite passes, either locally or on CI once you opened a pull request. | ||
| 5. Make sure your code lints (for example via `yarn lint --fix`). | ||
| 6. Push the changes to your fork. | ||
| 7. Create a pull request to the React Native repository. | ||
| 8. Review and address comments on your pull request. | ||
| 1. A bot may comment with suggestions. Generally we ask you to resolve these first before a maintainer will review your code. | ||
| 9. If you haven't already, complete the Contributor License Agreement ("CLA"). | ||
|
|
||
| If all goes well, your pull request will be merged. If it is not merged, maintainers will do their best to explain the reason why. | ||
|
|
||
| ### Step-by-step Guide | ||
|
|
||
| Whenever you are ready to contribute code, check out our [step-by-step guide to sending your first pull request](https://github.com/facebook/react-native/wiki/Pull-Requests#getting-ready-to-submit-your-first-pull-request), or read the [How to Contribute Code](https://github.com/facebook/react-native/wiki/How-to-Contribute) wiki for more details. | ||
|
|
||
| ### Tests | ||
|
|
||
| Tests help us prevent regressions from being introduced to the codebase. The GitHub repository is continuously tested using Circle and Appveyor, the results of which are available through the Checks functionality on [commits](https://github.com/facebook/react-native/commits/master) and pull requests. You can learn more about running and writing tests in the [Tests wiki](http://github.com/facebook/react-native/wiki/Tests). | ||
|
|
||
| We use Prettier to format our JavaScript code. This saves you time and energy as you can let Prettier fix up any formatting issues automatically through its editor integrations, or by manually running `npm run prettier`. We also use a linter to catch styling issues that may exist in your code. You can check the status of your code styling by simply running `npm run lint`. | ||
|
|
||
| However, there are still some styles that the linter cannot pick up, notably in Java or Objective-C code. | ||
| ## Community Contributions | ||
|
|
||
| **Objective-C:** | ||
| Contributions to React Native are not limited to GitHub. You can help others by sharing your experience using React Native, whether that is through blog posts, presenting talks at conferences, or simply sharing your thoughts on Twitter and tagging @ReactNative. | ||
|
|
||
| * Space after `@property` declarations | ||
| * Brackets on *every* `if`, on the *same* line | ||
| * `- method`, `@interface`, and `@implementation` brackets on the following line | ||
| * *Try* to keep it around 80 characters line length (sometimes it's just not possible...) | ||
| * `*` operator goes with the variable name (e.g. `NSObject *variableName;`) | ||
|
|
||
| **Java:** | ||
| ## Where to Get Help | ||
|
|
||
| * If a method call spans multiple lines closing bracket is on the same line as the last argument. | ||
| * If a method header doesn't fit on one line each argument goes on a separate line. | ||
| * 100 character line length | ||
| As you work on React Native, it is natural that sooner or later you may require help. In addition to the resources listed in [SUPPORT](http://github.com/facebook/react-native/blob/master/.github/SUPPORT.md), people interested in contributing may take advantage of the following: | ||
|
|
||
| ## License | ||
|
|
||
| By contributing to React Native, you agree that your contributions will be licensed | ||
| under the LICENSE file in the root directory of this source tree. | ||
| * **Twitter**. The React Native team at Facebook has its own account at [@reactnative](https://twitter.com/reactnative), and the React Native Community uses [@reactnativecomm](https://twitter.com/reactnativecomm). If you feel stuck, or need help contributing, please do not hesitate to reach out. | ||
| * **Proposals Repository**. If you are considering working on a feature large in scope, consider [creating a proposal first](https://github.com/react-native-community/discussions-and-proposals). The community can help you figure out the right approach, and we'd be happy to help. | ||
| * **React Native Community Discord**. While we try to hold most discussions in public, sometimes it can be beneficial to have conversations in real time with other contributors. People who have demonstrated a commitment to moving React Native forward through sustained contributions to the project may eventually be invited to join the React Native Community Discord. |