Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit de2cced

Browse files
committed
docs(guide/contribute): remove redundancy and link to CONTRIBUTING.md
1 parent 8416602 commit de2cced

File tree

2 files changed

+133
-202
lines changed

2 files changed

+133
-202
lines changed

CONTRIBUTING.md

+55-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ You can request a new feature by submitting an issue to our [GitHub Repository][
2424
would like to implement a new feature then consider what kind of change it is:
2525

2626
* **Major Changes** that you wish to contribute to the project should be discussed first on our
27-
[mailing list][groups] or [IRC][irc] so that we can better coordinate our efforts, prevent
27+
[dev mailing list][angular-dev] or [IRC][irc] so that we can better coordinate our efforts, prevent
2828
duplication of work, and help you to craft the change so that it is successfully accepted into the
2929
project.
3030
* **Small Changes** can be crafted and submitted to [GitHub Repository][github] as a Pull Request.
@@ -145,12 +145,65 @@ changes to be accepted, the CLA must be signed. It's a quick process, we promise
145145
You can find out more detailed information about contributing in the
146146
[AngularJS documentation][contributing].
147147

148+
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+
199+
148200
[github]: https://github.com/angular/angular.js
149201
[Google Closure I18N library]: https://code.google.com/p/closure-library/source/browse/closure/goog/i18n/
150202
[list]: https://groups.google.com/forum/?fromgroups#!forum/angular
151203
[contribute]: http://docs.angularjs.org/misc/contribute
152204
[stackoverflow]: http://stackoverflow.com/questions/tagged/angularjs
153205
[groups]: https://groups.google.com/forum/?fromgroups#!forum/angular
206+
[angular-dev]: https://groups.google.com/forum/?fromgroups#!forum/angular-dev
154207
[irc]: http://webchat.freenode.net/?channels=angularjs&uio=d4
155208
[plunker]: http://plnkr.co/edit
156209
[jsfiddle]: http://jsfiddle.net/
@@ -160,4 +213,4 @@ You can find out more detailed information about contributing in the
160213
[contributing]: http://docs.angularjs.org/misc/contribute
161214
[individual-cla]: http://code.google.com/legal/individual-cla-v1.0.html
162215
[corporate-cla]: http://code.google.com/legal/corporate-cla-v1.0.html
163-
[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
216+
[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#

0 commit comments

Comments
 (0)