From f5b1f157add9974b96def078592505b8b735950b Mon Sep 17 00:00:00 2001 From: zxcpoiu Date: Sun, 12 Jun 2016 23:35:28 -0700 Subject: [PATCH] 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 :scream: **Test plan (required)** Closes https://github.com/facebook/react-native/pull/8081 Differential Revision: D3424076 fbshipit-source-id: 6c5f1b0b2f0bee03c647c2f8cad00b788130a5fc --- CONTRIBUTING.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cc5376c9c..f6c1e2407 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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! 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 -``` -$ cd website -$ npm install && npm start -go to: http://localhost:8079/react-native/index.html -``` + + ``` + $ cd website + $ 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. 6. Ensure tests pass on Travis and Circle CI. 7. Make sure your code lints (`node linter.js `). -8. Squash your commits (`git rebase -i`). -9. If you haven't already, sign the [CLA](https://code.facebook.com/cla). +8. 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