status-im
/
react-native
mirror of https://github.com/status-im/react-native.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

improve CONTRIBUTING.md about Pull Request 

Summary:
**motivation**

Lots of people does not sure what to do after a PR.
common questions like:

* should I keep rebasing this PR to the latest master branch ?
* should I keep squashing all commits in a PR into single one?

This may clear it a bit and makes people less nervous 😱

**Test plan (required)**
Closes https://github.com/facebook/react-native/pull/8081

Differential Revision: D3424076

fbshipit-source-id: 6c5f1b0b2f0bee03c647c2f8cad00b788130a5fc
This commit is contained in:
zxcpoiu 2016-06-12 23:35:28 -07:00 committed by Facebook Github Bot 9
parent f29e195cb7
commit f5b1f157ad
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -20,16 +20,21 @@ The core team will be monitoring for pull requests. When we get one, we'll run s
2. **Describe your test plan in your commit.** If you've added code that should be tested, add tests! 2. **Describe your test plan in your commit.** If you've added code that should be tested, add tests!
3. If you've changed APIs, update the documentation. 3. If you've changed APIs, update the documentation.
4. If you've updated the docs, verify the website locally and submit screenshots if applicable 4. If you've updated the docs, verify the website locally and submit screenshots if applicable
```
$ cd website ```
$ npm install && npm start $ cd website
go to: http://localhost:8079/react-native/index.html $ npm install && npm start
``` go to: http://localhost:8079/react-native/index.html
```
5. Add the copyright notice to the top of any new files you've added. 5. Add the copyright notice to the top of any new files you've added.
6. Ensure tests pass on Travis and Circle CI. 6. Ensure tests pass on Travis and Circle CI.
7. Make sure your code lints (`node linter.js <files touched>`). 7. Make sure your code lints (`node linter.js <files touched>`).
8. Squash your commits (`git rebase -i`). 8. If you haven't already, sign the [CLA](https://code.facebook.com/cla).
9. If you haven't already, sign the [CLA](https://code.facebook.com/cla). 9. Squash your commits (`git rebase -i`).
one intent alongs with one commit makes it clearer for people to review and easier to understand your intention
Note: It is not necessary to keep clicking `Merge master to your branch` on PR page. You would want to merge master if there are conflicts or tests are failing. The facebook-bot ultimately squashes all commits to a single one before merging your PR.
#### Copyright Notice for files #### Copyright Notice for files