diff options
| author | Pete Bacon Darwin | 2013-11-25 14:15:24 +0000 |
|---|---|---|
| committer | Pete Bacon Darwin | 2013-11-25 14:15:24 +0000 |
| commit | 66b0fcd3c00075dade7c090f425e80eae2e30d43 (patch) | |
| tree | 17b0a8ad4d259618a4015b7f690f8a81c6f05172 | |
| parent | 2efe82309ac8ff4f67df8b6e40a539ea31e15804 (diff) | |
| download | angular.js-66b0fcd3c00075dade7c090f425e80eae2e30d43.tar.bz2 | |
docs(CONTRIBUTING): consolidated submitting PRs sections
| -rw-r--r-- | CONTRIBUTING.md | 112 |
1 files changed, 56 insertions, 56 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ee00e92..1fa75301 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,16 +46,66 @@ features, by not reporting duplicate issues. ### Submitting a Pull Request Before you submit your pull request follow the following guidelines: -* Search GitHub for an open or closed Pull Request that relates to your submission. You don't want - to duplicate effort. +* Search [GitHub](https://github.com/angular/angular.js/pulls) for an open or closed Pull Request + that relates to your submission. You don't want to duplicate effort. +* Please sign our [Contributor License Agreement (CLA)](#signing-the-cla) before sending pull + requests. We cannot accept code without this. * Make your changes in a new git branch + + ```shell + git checkout -b my-fix-branch master + ``` + +* Create your patch, including appropriate test cases. * Follow our Coding Rules -* Follow our Git Commit Guidelines -* Build your changes locally and on Travis (by pushing to GitHub) to ensure all the tests pass. -* Sign the Contributor License Agreement (CLA). We cannot accept code without this. +* Commit your changes and create a descriptive commit message (the + commit message is used to generate release notes, please check out our + [commit message conventions](#commit-message-format) and our commit message presubmit hook + `validate-commit-msg.js`): + + ```shell + git commit -a + ``` + +* Build your changes locally to ensure all the tests pass + + ```shell + grunt test + ``` + +* Push your branch to Github: + + ```shell + git push origin my-fix-branch + ``` + +* In Github, send a pull request to `angular:master`. * If we suggest changes then you can modify your branch, rebase and force a new push to your GitHub - repository to update the Pull Request. + repository to update the Pull Request: + + ```shell + git rebase master -i + git push -f + ``` + +That's it! Thank you for your contribution! + +When the patch is reviewed and merged, you can safely delete your branch and pull the changes +from the main (upstream) repository: +```shell +# Delete the remote branch on Github: +git push origin --delete my-fix-branch + +# Check out the master branch: +git checkout master -f + +# Delete the local branch: +git branch -D my-fix-branch + +# Update your master with the latest upstream version: +git pull --ff upstream master +``` ## Coding Rules To ensure consistency throughout the source code, keep these rules in mind as you are working: @@ -146,56 +196,6 @@ You can find out more detailed information about contributing in the [AngularJS documentation][contributing]. -## Submitting Your Changes - -To create and submit a change: - -1. Please sign our [Contributor License Agreement (CLA)](#signing-the-cla) before sending pull - requests. - -2. Create and checkout a new branch off the master branch for your changes: - - ```shell - git checkout -b my-fix-branch master - ``` - -3. Create your patch, including appropriate test cases. - -4. Commit your changes and create a descriptive commit message (the commit message is used to - generate release notes, please check out our [commit message conventions](#commit-message-format) - and our commit message presubmit hook `validate-commit-msg.js`): - - ```shell - git commit -a - ``` - -5. Push your branch to Github: - - ```shell - git push origin my-fix-branch - ``` - -6. In Github, send a pull request to `angular:master`. - -That's it! Thank you for your contribution! - -When the patch is reviewed and merged, you can safely delete your branch and pull the changes -from the main (upstream) repository: - -```shell -# Delete the remote branch on Github: -git push origin :my-fix-branch - -# Check out the master branch: -git checkout master - -# Delete the local branch: -git branch -D my-fix-branch - -# Update your master with the latest upstream version: -git pull --ff upstream master -``` - [github]: https://github.com/angular/angular.js [Google Closure I18N library]: https://code.google.com/p/closure-library/source/browse/closure/goog/i18n/ |
