X Tutup
Skip to content

Commit 794e5e6

Browse files
ashley williamsbtford
authored andcommitted
docs(contribute): add table of contents to contributing doc
- add linked list to top of document - add anchor elements to secondary headings closes angular#6287
1 parent f4f1f43 commit 794e5e6

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,25 @@
33
We'd love for you to contribute to our source code and to make AngularJS even better than it is
44
today! Here are the guidelines we'd like you to follow:
55

6-
## Code of Conduct
6+
- [Code of Conduct](#coc)
7+
- [Question or Problem?](#question)
8+
- [Issues and Bugs](#issue)
9+
- [Feature Requests](#feature)
10+
- [Submission Guidelines](#submit)
11+
- [Coding Rules](#rules)
12+
- [Commit Message Guidelines](#commit)
13+
- [Signing the CLA](#cla)
14+
- [Further Info](#info)
15+
16+
## <a name="coc"></a> Code of Conduct
717
Help us keep Angular open and inclusive. Please read and follow our [Code of Conduct][coc].
818

9-
## Got a Question or Problem?
19+
## <a name="question"></a> Got a Question or Problem?
1020

1121
If you have questions about how to use AngularJS, please direct these to the [Google Group][groups]
1222
discussion list or [StackOverflow][stackoverflow]. We are also available on [IRC][irc].
1323

14-
## Found an Issue?
24+
## <a name="issue"></a> Found an Issue?
1525
If you find a bug in the source code or a mistake in the documentation, you can help us by
1626
submitting and issue to our [GitHub Repository][github]. Even better you can submit a Pull Request
1727
with a fix.
@@ -22,7 +32,7 @@ approach is to submit a patch to the I18N project directly, instead of submittin
2232

2333
**Please see the Submission Guidelines below**.
2434

25-
## Want a Feature?
35+
## <a name="feature"></a> Want a Feature?
2636
You can request a new feature by submitting an issue to our [GitHub Repository][github]. If you
2737
would like to implement a new feature then consider what kind of change it is:
2838

@@ -33,7 +43,7 @@ project.
3343
* **Small Changes** can be crafted and submitted to [GitHub Repository][github] as a Pull Request.
3444

3545

36-
## Want a Doc Fix?
46+
## <a name="docs"></a> Want a Doc Fix?
3747
If you want to help improve the docs, it's a good idea to let others know what you're working on to
3848
minimize duplication of effort. Before starting, check out the issue queue for [Milestone:Docs Only](https://github.com/angular/angular.js/issues?milestone=24&state=open).
3949
Comment on an issue to let others know what you're working on, or create a new issue if your work
@@ -45,7 +55,7 @@ is labeled "docs:" and follows the **Git Commit Guidelines** outlined below.
4555

4656
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.
4757

48-
## Submission Guidelines
58+
## <a name="submit"></a> Submission Guidelines
4959

5060
### Submitting an Issue
5161
Before you submit your issue search the archive, maybe your question was already answered.
@@ -143,7 +153,7 @@ from the main (upstream) repository:
143153
git pull --ff upstream master
144154
```
145155
146-
## Coding Rules
156+
## <a name="rules"></a> Coding Rules
147157
To ensure consistency throughout the source code, keep these rules in mind as you are working:
148158
149159
* All features or bug fixes **must be tested** by one or more [specs][unit-testing].
@@ -163,7 +173,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
163173
* We **don't go crazy with type annotations** for private internal APIs unless it's an internal API
164174
that is used throughout AngularJS. The best guidance is to do what makes the most sense.
165175

166-
## Git Commit Guidelines
176+
## <a name="commit"></a> Git Commit Guidelines
167177

168178
We have very precise rules over how our git commit messages can be formatted. This leads to **more
169179
readable messages** that are easy to follow when looking through the **project history**. But also,
@@ -220,7 +230,7 @@ reference GitHub issues that this commit **Closes**.
220230
221231
A detailed explanation can be found in this [document][commit-message-format].
222232
223-
## Signing the CLA
233+
## <a name="cla"></a> Signing the CLA
224234
225235
Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code
226236
changes to be accepted, the CLA must be signed. It's a quick process, we promise!
@@ -229,7 +239,7 @@ changes to be accepted, the CLA must be signed. It's a quick process, we promise
229239
* For corporations we'll need you to
230240
[print, sign and one of scan+email, fax or mail the form][corporate-cla].
231241
232-
## Further Information
242+
## <a name="info"></a> Further Information
233243
You can find out more detailed information about contributing in the
234244
[AngularJS documentation][contributing].
235245

0 commit comments

Comments
 (0)
X Tutup