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

Commit e8e8186

Browse files
committed
docs(CONTRIBUTING.md): minor improvements
Closes #15008
1 parent 0f3385d commit e8e8186

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.
@@ -30,46 +33,53 @@ with a fix.
3033
any changes to these files would be lost the next time that we import the library. The recommended
3134
approach is to submit a patch to the I18N project directly, instead of submitting it here.*
3235

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

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

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

4550

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

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

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

5969
## <a name="submit"></a> Submission Guidelines
6070

6171
### Submitting an Issue
6272
Before you submit your issue search the archive, maybe your question was already answered.
6373

64-
If your issue appears to be a bug, and hasn't been reported, open a new issue.
65-
Help us to maximize the effort we can spend fixing issues and adding new
66-
features, by not reporting duplicate issues. Providing the following information will increase the
67-
chances of your issue being dealt with quickly:
74+
If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize
75+
the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
76+
Providing the following information will increase the chances of your issue being dealt with
77+
quickly:
6878

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

92-
```shell
93-
git checkout -b my-fix-branch master
94-
```
102+
```shell
103+
git checkout -b my-fix-branch master
104+
```
95105

96106
* Create your patch, **including appropriate test cases**.
97107
* Follow our [Coding Rules](#rules).
98108
* Run the full Angular test suite, as described in the [developer documentation][dev-doc],
99109
and ensure that all tests pass.
100110
* Commit your changes using a descriptive commit message that follows our
101-
[commit message conventions](#commit-message-format) and passes our commit message presubmit hook
102-
`validate-commit-msg.js`. Adherence to the [commit message conventions](#commit-message-format)
103-
is required because release notes are automatically generated from these messages.
111+
[commit message conventions](#commit) and passes our commit message presubmit hook
112+
(`validate-commit-msg.js`). Adherence to the [commit message conventions](#commit) is required,
113+
because release notes are automatically generated from these messages.
104114

105-
```shell
106-
git commit -a
107-
```
115+
```shell
116+
git commit -a
117+
```
108118
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
109119

110120
* Build your changes locally to ensure all the tests pass:
@@ -119,12 +129,13 @@ Before you submit your pull request consider the following guidelines:
119129
git push origin my-fix-branch
120130
```
121131

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

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

@@ -133,8 +144,9 @@ git rebase master -i
133144
git push origin my-fix-branch -f
134145
```
135146

136-
*WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments
137-
on code that were previously made by you and others in your commits.*
147+
_WARNING: Squashing or reverting commits and force-pushing thereafter may remove GitHub comments
148+
on code that were previously made by you or others in your commits. Avoid any form of rebasing
149+
unless necessary._
138150

139151
That's it! Thank you for your contribution!
140152
@@ -168,6 +180,7 @@ from the main (upstream) repository:
168180
```
169181
170182
## <a name="rules"></a> Coding Rules
183+
171184
To ensure consistency throughout the source code, keep these rules in mind as you are working:
172185
173186
* All features or bug fixes **must be tested** by one or more [specs][unit-testing].

0 commit comments

Comments
 (0)