Skip to content

Commit 66b0fcd

Browse files
docs(CONTRIBUTING): consolidated submitting PRs sections
1 parent 2efe823 commit 66b0fcd

File tree

1 file changed

+56
-56
lines changed

1 file changed

+56
-56
lines changed

CONTRIBUTING.md

+56-56
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,66 @@ features, by not reporting duplicate issues.
4646
### Submitting a Pull Request
4747
Before you submit your pull request follow the following guidelines:
4848

49-
* Search GitHub for an open or closed Pull Request that relates to your submission. You don't want
50-
to duplicate effort.
49+
* Search [GitHub](https://github.com/angular/angular.js/pulls) for an open or closed Pull Request
50+
that relates to your submission. You don't want to duplicate effort.
51+
* Please sign our [Contributor License Agreement (CLA)](#signing-the-cla) before sending pull
52+
requests. We cannot accept code without this.
5153
* Make your changes in a new git branch
54+
55+
```shell
56+
git checkout -b my-fix-branch master
57+
```
58+
59+
* Create your patch, including appropriate test cases.
5260
* Follow our Coding Rules
53-
* Follow our Git Commit Guidelines
54-
* Build your changes locally and on Travis (by pushing to GitHub) to ensure all the tests pass.
55-
* Sign the Contributor License Agreement (CLA). We cannot accept code without this.
61+
* Commit your changes and create a descriptive commit message (the
62+
commit message is used to generate release notes, please check out our
63+
[commit message conventions](#commit-message-format) and our commit message presubmit hook
64+
`validate-commit-msg.js`):
65+
66+
```shell
67+
git commit -a
68+
```
69+
70+
* Build your changes locally to ensure all the tests pass
71+
72+
```shell
73+
grunt test
74+
```
75+
76+
* Push your branch to Github:
77+
78+
```shell
79+
git push origin my-fix-branch
80+
```
81+
82+
* In Github, send a pull request to `angular:master`.
5683
* If we suggest changes then you can modify your branch, rebase and force a new push to your GitHub
57-
repository to update the Pull Request.
84+
repository to update the Pull Request:
85+
86+
```shell
87+
git rebase master -i
88+
git push -f
89+
```
90+
91+
That's it! Thank you for your contribution!
92+
93+
When the patch is reviewed and merged, you can safely delete your branch and pull the changes
94+
from the main (upstream) repository:
5895
96+
```shell
97+
# Delete the remote branch on Github:
98+
git push origin --delete my-fix-branch
99+
100+
# Check out the master branch:
101+
git checkout master -f
102+
103+
# Delete the local branch:
104+
git branch -D my-fix-branch
105+
106+
# Update your master with the latest upstream version:
107+
git pull --ff upstream master
108+
```
59109
## Coding Rules
60110
To ensure consistency throughout the source code, keep these rules in mind as you are working:
61111
@@ -146,56 +196,6 @@ You can find out more detailed information about contributing in the
146196
[AngularJS documentation][contributing].
147197
148198
149-
## Submitting Your Changes
150-
151-
To create and submit a change:
152-
153-
1. Please sign our [Contributor License Agreement (CLA)](#signing-the-cla) before sending pull
154-
requests.
155-
156-
2. Create and checkout a new branch off the master branch for your changes:
157-
158-
```shell
159-
git checkout -b my-fix-branch master
160-
```
161-
162-
3. Create your patch, including appropriate test cases.
163-
164-
4. Commit your changes and create a descriptive commit message (the commit message is used to
165-
generate release notes, please check out our [commit message conventions](#commit-message-format)
166-
and our commit message presubmit hook `validate-commit-msg.js`):
167-
168-
```shell
169-
git commit -a
170-
```
171-
172-
5. Push your branch to Github:
173-
174-
```shell
175-
git push origin my-fix-branch
176-
```
177-
178-
6. In Github, send a pull request to `angular:master`.
179-
180-
That's it! Thank you for your contribution!
181-
182-
When the patch is reviewed and merged, you can safely delete your branch and pull the changes
183-
from the main (upstream) repository:
184-
185-
```shell
186-
# Delete the remote branch on Github:
187-
git push origin :my-fix-branch
188-
189-
# Check out the master branch:
190-
git checkout master
191-
192-
# Delete the local branch:
193-
git branch -D my-fix-branch
194-
195-
# Update your master with the latest upstream version:
196-
git pull --ff upstream master
197-
```
198-
199199
200200
[github]: https://github.com/angular/angular.js
201201
[Google Closure I18N library]: https://code.google.com/p/closure-library/source/browse/closure/goog/i18n/

0 commit comments

Comments
 (0)