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

Commit 42a0061

Browse files
committedAug 10, 2016
docs(CONTRIBUTING.md): minor improvements
Closes #15008
1 parent b6340d1 commit 42a0061

File tree

1 file changed

+49
-36
lines changed

1 file changed

+49
-36
lines changed
 

‎CONTRIBUTING.md

+49-36
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,17 @@ today! Here are the guidelines we'd like you to follow:
1414
- [Further Info](#info)
1515

1616
## <a name="coc"></a> Code of Conduct
17+
1718
Help us keep Angular open and inclusive. Please read and follow our [Code of Conduct][coc].
1819

1920
## <a name="question"></a> Got a Question or Problem?
2021

2122
If you have questions about how to use AngularJS, please direct these to the [Google Group][groups]
22-
discussion list or [StackOverflow][stackoverflow]. We are also available on [IRC][irc] and [Gitter][gitter].
23+
discussion list or [StackOverflow][stackoverflow]. We are also available on [IRC][irc] and
24+
[Gitter][gitter].
2325

2426
## <a name="issue"></a> Found an Issue?
27+
2528
If you find a bug in the source code or a mistake in the documentation, you can help us by
2629
submitting an issue to our [GitHub Repository][github]. Even better you can submit a Pull Request
2730
with a fix.
@@ -33,46 +36,53 @@ Since the Closure library i18n data is itself auto-generated from the data of th
3336
[Common Locale Data Repository (CLDR)] project, errors in the data should
3437
be reported there. See also the [Closure guide to i18n changes].
3538

36-
**Please see the Submission Guidelines below**.
39+
**Please see the [Submission Guidelines](#submit) below.**
3740

3841
## <a name="feature"></a> Want a Feature?
42+
3943
You can request a new feature by submitting an issue to our [GitHub Repository][github]. If you
4044
would like to implement a new feature then consider what kind of change it is:
4145

4246
* **Major Changes** that you wish to contribute to the project should be discussed first on our
43-
[dev mailing list][angular-dev] or [IRC][irc] so that we can better coordinate our efforts, prevent
44-
duplication of work, and help you to craft the change so that it is successfully accepted into the
45-
project.
46-
* **Small Changes** can be crafted and submitted to the [GitHub Repository][github] as a Pull Request.
47+
[dev mailing list][angular-dev] or [IRC][irc] so that we can better coordinate our efforts,
48+
prevent duplication of work, and help you to craft the change so that it is successfully accepted
49+
into the project.
50+
* **Small Changes** can be crafted and submitted to the [GitHub Repository][github] as a Pull
51+
Request.
4752

4853

4954
## <a name="docs"></a> Want a Doc Fix?
55+
5056
If you want to help improve the docs, it's a good idea to let others know what you're working on to
51-
minimize duplication of effort. Before starting, check out the issue queue for
52-
[Milestone:Docs Only](https://github.com/angular/angular.js/issues?milestone=24&state=open).
53-
Comment on an issue to let others know what you're working on, or create a new issue if your work
54-
doesn't fit within the scope of any of the existing doc fix projects.
57+
minimize duplication of effort. Create a new issue (or comment on a related existing one) to let
58+
others know what you're working on.
5559

56-
For large fixes, please build and test the documentation before submitting the PR to be sure you haven't
57-
accidentally introduced any layout or formatting issues. You should also make sure that your commit message
58-
is labeled "docs:" and follows the **Git Commit Guidelines** outlined below.
60+
For large fixes, please build and test the documentation before submitting the PR to be sure you
61+
haven't accidentally introduced any layout or formatting issues. You should also make sure that your
62+
commit message starts with "docs" and follows the **[Commit Message Guidelines](#commit)** outlined
63+
below.
5964

60-
If you're just making a small change, don't worry about filing an issue first. Use the friendly blue "Improve this doc" button at the top right of the doc page to fork the repository in-place and make a quick change on the fly. When naming the commit, it is advised to still label it according to the commit guidelines below, by starting the commit message with **docs** and referencing the filename. Since this is not obvious and some changes are made on the fly, this is not strictly necessary and we will understand if this isn't done the first few times.
65+
If you're just making a small change, don't worry about filing an issue first. Use the friendly blue
66+
"Improve this doc" button at the top right of the doc page to fork the repository in-place and make
67+
a quick change on the fly. When naming the commit, it is advised to follow the commit message
68+
guidelines below, by starting the commit message with **docs** and referencing the filename. Since
69+
this is not obvious and some changes are made on the fly, this is not strictly necessary and we will
70+
understand if this isn't done the first few times.
6171

6272
## <a name="submit"></a> Submission Guidelines
6373

6474
### Submitting an Issue
6575
Before you submit your issue search the archive, maybe your question was already answered.
6676

67-
If your issue appears to be a bug, and hasn't been reported, open a new issue.
68-
Help us to maximize the effort we can spend fixing issues and adding new
69-
features, by not reporting duplicate issues. Providing the following information will increase the
70-
chances of your issue being dealt with quickly:
77+
If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize
78+
the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
79+
Providing the following information will increase the chances of your issue being dealt with
80+
quickly:
7181

7282
* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
7383
* **Motivation for or Use Case** - explain why this is a bug for you
7484
* **Angular Version(s)** - is it a regression?
75-
* **Browsers and Operating System** - is this a problem with all browsers or only IE8?
85+
* **Browsers and Operating System** - is this a problem with all browsers or only specific ones?
7686
* **Reproduce the Error** - provide a live example (using [Plunker][plunker] or
7787
[JSFiddle][jsfiddle]) or an unambiguous set of steps.
7888
* **Related Issues** - has a similar issue been reported before?
@@ -92,22 +102,22 @@ Before you submit your pull request consider the following guidelines:
92102
requests. We cannot accept code without this.
93103
* Make your changes in a new git branch:
94104

95-
```shell
96-
git checkout -b my-fix-branch master
97-
```
105+
```shell
106+
git checkout -b my-fix-branch master
107+
```
98108

99109
* Create your patch, **including appropriate test cases**.
100110
* Follow our [Coding Rules](#rules).
101111
* Run the full Angular test suite, as described in the [developer documentation][dev-doc],
102112
and ensure that all tests pass.
103113
* Commit your changes using a descriptive commit message that follows our
104-
[commit message conventions](#commit-message-format) and passes our commit message presubmit hook
105-
`validate-commit-msg.js`. Adherence to the [commit message conventions](#commit-message-format)
106-
is required because release notes are automatically generated from these messages.
114+
[commit message conventions](#commit) and passes our commit message presubmit hook
115+
(`validate-commit-msg.js`). Adherence to the [commit message conventions](#commit) is required,
116+
because release notes are automatically generated from these messages.
107117

108-
```shell
109-
git commit -a
110-
```
118+
```shell
119+
git commit -a
120+
```
111121
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
112122

113123
* Build your changes locally to ensure all the tests pass:
@@ -122,12 +132,13 @@ Before you submit your pull request consider the following guidelines:
122132
git push origin my-fix-branch
123133
```
124134

125-
* In GitHub, send a pull request to `angular:master`.
126-
* If we suggest changes then:
127-
* Make the required updates.
128-
* Re-run the Angular test suite to ensure tests are still passing.
129-
* Commit your changes to your branch (e.g. `my-fix-branch`).
130-
* Push the changes to your GitHub repository (this will update your Pull Request).
135+
In GitHub, send a pull request to `angular:master`.
136+
If we suggest changes, then:
137+
138+
* Make the required updates.
139+
* Re-run the Angular test suite to ensure tests are still passing.
140+
* Commit your changes to your branch (e.g. `my-fix-branch`).
141+
* Push the changes to your GitHub repository (this will update your Pull Request).
131142

132143
If the PR gets too outdated we may ask you to rebase and force push to update the PR:
133144

@@ -136,8 +147,9 @@ git rebase master -i
136147
git push origin my-fix-branch -f
137148
```
138149

139-
*WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments
140-
on code that were previously made by you and others in your commits.*
150+
_WARNING: Squashing or reverting commits and force-pushing thereafter may remove GitHub comments
151+
on code that were previously made by you or others in your commits. Avoid any form of rebasing
152+
unless necessary._
141153

142154
That's it! Thank you for your contribution!
143155
@@ -171,6 +183,7 @@ from the main (upstream) repository:
171183
```
172184
173185
## <a name="rules"></a> Coding Rules
186+
174187
To ensure consistency throughout the source code, keep these rules in mind as you are working:
175188
176189
* All features or bug fixes **must be tested** by one or more [specs][unit-testing].

0 commit comments

Comments
 (0)
This repository has been archived.