mirror of
https://github.com/zhigang1992/angular.js.git
synced 2026-04-28 21:05:43 +08:00
docs(CONTRIBUTING): consolidated submitting PRs sections
This commit is contained in:
116
CONTRIBUTING.md
116
CONTRIBUTING.md
@@ -46,16 +46,66 @@ features, by not reporting duplicate issues.
|
|||||||
### Submitting a Pull Request
|
### Submitting a Pull Request
|
||||||
Before you submit your pull request follow the following guidelines:
|
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
|
* Search [GitHub](https://github.com/angular/angular.js/pulls) for an open or closed Pull Request
|
||||||
to duplicate effort.
|
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
|
* Make your changes in a new git branch
|
||||||
* 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.
|
|
||||||
* 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.
|
|
||||||
|
|
||||||
|
```shell
|
||||||
|
git checkout -b my-fix-branch master
|
||||||
|
```
|
||||||
|
|
||||||
|
* Create your patch, including appropriate test cases.
|
||||||
|
* Follow our Coding Rules
|
||||||
|
* 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:
|
||||||
|
|
||||||
|
```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
|
## Coding Rules
|
||||||
To ensure consistency throughout the source code, keep these rules in mind as you are working:
|
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].
|
[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
|
[github]: https://github.com/angular/angular.js
|
||||||
[Google Closure I18N library]: https://code.google.com/p/closure-library/source/browse/closure/goog/i18n/
|
[Google Closure I18N library]: https://code.google.com/p/closure-library/source/browse/closure/goog/i18n/
|
||||||
|
|||||||
Reference in New Issue
Block a user