84 lines
4.1 KiB
Markdown
84 lines
4.1 KiB
Markdown
# Contributing to React Native
|
|
|
|
React Native 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](https://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 preempts some questions you may have.
|
|
|
|
## Our Development Process
|
|
|
|
Some of the core team will be working directly on GitHub. These changes will be public from the beginning. Other changesets will come via a bridge with Facebook's internal source control. This is a necessity as it allows engineers at Facebook outside of the core team to move fast and contribute from an environment they are comfortable in.
|
|
|
|
### `master` is unsafe
|
|
|
|
We will do our best to keep `master` 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 will do our best to communicate these changes and version appropriately so you can lock into a specific version if need be.
|
|
|
|
### Pull Requests
|
|
|
|
The core team will be monitoring for pull requests. When we get one, we'll run some Facebook-specific integration tests on it first. From here, we'll need to get another person to sign off on the changes and then merge the pull request. For API changes we may need to fix internal uses, 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…
|
|
|
|
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 tests pass on Travis.
|
|
5. Make sure your code lints (`node linter.js <files touched>`).
|
|
6. 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.
|
|
|
|
[Complete your CLA here](https://code.facebook.com/cla)
|
|
|
|
## Bugs
|
|
|
|
### Where to Find Known Issues
|
|
|
|
We will be using GitHub Issues for our public bugs. We will 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. Please provide either a public repository with a runnable example or a [React Native Playground](https://rnplay.org/) snippet.
|
|
|
|
### Security Bugs
|
|
|
|
Facebook has a [bounty program](https://www.facebook.com/whitehat/) 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
|
|
|
|
* IRC - [#reactnative on freenode](http://webchat.freenode.net/?channels=reactnative)
|
|
* [Facebook group](https://www.facebook.com/groups/react.native.community/)
|
|
|
|
## Style Guide
|
|
|
|
### Code
|
|
|
|
#### General
|
|
|
|
* Add trailing commas,
|
|
* 2 spaces for indentation (no tabs)
|
|
* "Attractive"
|
|
|
|
#### JavaScript
|
|
|
|
* Use semicolons;
|
|
* `'use strict';`
|
|
* Prefer `'` over `"`
|
|
* Do not use the optional parameters of `setTimeout` and `setInterval`
|
|
* 80 character line length
|
|
|
|
#### Objective-C
|
|
|
|
* 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;`)
|
|
|
|
### Documentation
|
|
|
|
* Do not wrap lines at 80 characters - configure your editor to soft-wrap when editing documentation.
|
|
|
|
## License
|
|
|
|
By contributing to React Native, you agree that your contributions will be licensed under its BSD license.
|