Skip to content

Commit 7a6d2a1

Browse files
chalinrkirov
authored andcommitted
chore(contributing): fix links and other updates
Fix some links and merge relevant updates made to Angular 2's CONTRIBUTING.md.
1 parent ede5307 commit 7a6d2a1

File tree

1 file changed

+42
-47
lines changed

1 file changed

+42
-47
lines changed

CONTRIBUTING.md

+42-47
Original file line numberDiff line numberDiff line change
@@ -20,82 +20,78 @@ Help us keep Angular open and inclusive. Please read and follow our [Code of Con
2020

2121
## <a name="question"></a> Got a Question or Problem?
2222

23-
If you have questions about how to use AngularDart, please direct them to the [Google Group][groups]
23+
If you have questions about how to *use* AngularDart, please direct them to the [Google Group][angular-group]
2424
discussion list or [StackOverflow][stackoverflow].
2525

2626
## <a name="issue"></a> Found an Issue?
2727
If you find a bug in the source code or a mistake in the documentation, you can help us by
28-
submitting an issue to our [GitHub Repository][github]. Even better, you can submit a Pull Request
29-
with a fix.
30-
31-
**Please see the Submission Guidelines below**.
28+
[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can
29+
[submit a Pull Request](#submit-pr) with a fix.
3230

3331
## <a name="feature"></a> Want a Feature?
34-
You can request a new feature by submitting an issue to our [GitHub Repository][github]. If you
35-
would like to implement a new feature then consider what kind of change it is:
36-
37-
<!--
38-
* **Major Changes** that you wish to contribute to the project should be discussed first on our
39-
[dev mailing list][angular-dev] or [IRC][irc] so that we can better coordinate our efforts, prevent
40-
duplication of work, and help you to craft the change so that it is successfully accepted into the
41-
project.
42-
-->
43-
* **Small Changes** can be crafted and submitted to [GitHub Repository][github] as a Pull Request.
32+
You can *request* a new feature by [submitting an issue](#submit-issue) to our [GitHub
33+
Repository][github]. If you would like to *implement* a new feature then consider what kind of
34+
change it is:
4435

36+
* For a **Major Feature**, first open an issue and outline your proposal so that it can be
37+
discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
38+
and help you to craft the change so that it is successfully accepted into the project.
39+
* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
4540

4641
## <a name="docs"></a> Want a Doc Fix?
47-
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.
49-
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.
52-
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.
42+
If you want to help improve the docs, then consider what kind of improvement it is:
43+
44+
* For **Major Changes**, it's a good idea to let others know what you're working on to
45+
minimize duplication of effort. Before starting, check out the issue queue for
46+
issues labeled [#docs](https://github.com/angular/angular/labels/%23docs).
47+
Comment on an issue to let others know what you're working on, or [create a new issue](#submit-issue)
48+
if your work doesn't fit within the scope of any of the existing doc issues.
49+
Please build and test the documentation before [submitting the Pull Request](#submit-pr), to be sure
50+
you haven't accidentally introduced any layout or formatting issues. Also ensure that your commit
51+
message is labeled "docs" and follows the [Commit Message Guidelines](#commit) given below.
52+
* For **Small Changes**, there is no need to file an issue first. Simply [submit a Pull Request](#submit-pr).
5653

5754
## <a name="submit"></a> Submission Guidelines
5855

59-
### Submitting an Issue
60-
Before you submit your issue search the archive, maybe your question was already answered.
56+
### <a name="submit-issue"></a> Submitting an Issue
57+
Before you submit an issue, search the archive, maybe your question was already answered.
6158

6259
If your issue appears to be a bug, and hasn't been reported, open a new issue.
6360
Help us to maximize the effort we can spend fixing issues and adding new
6461
features, by not reporting duplicate issues. Providing the following information will increase the
6562
chances of your issue being dealt with quickly:
6663

67-
* **Overview of the issue** - if an error is being thrown a non-minified stack trace helps
64+
* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
6865
* **Motivation for or Use Case** - explain why this is a bug for you
6966
* **Angular Version(s)** - is it a regression?
70-
* **Browsers and Operating System** - is this a problem with all browsers or only IE8?
71-
* **Reproduce the error** - provide a live example (using [Runnable][runnable]) or a unambiguous set of steps.
72-
* **Related issues** - has a similar issue been reported before?
67+
* **Browsers and Operating System** - is this a problem with all browsers?
68+
* **Reproduce the Error** - provide a live example (using [Runnable][runnable]) or a unambiguous set of steps.
69+
* **Related Issues** - has a similar issue been reported before?
7370
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
7471
causing the problem (line of code or commit)
7572

7673
**If you get help, help others. Good karma rulez!**
7774

78-
### Submitting a Pull Request
79-
Before you submit your pull request consider the following guidelines:
75+
### <a name="submit-pr"></a> Submitting a Pull Request (PR)
76+
Before you submit your Pull Request (PR) consider the following guidelines:
8077

81-
* Search [GitHub](https://github.com/angular/angular.dart/pulls) for an open or closed Pull Request
78+
* Search [GitHub](https://github.com/angular/angular.dart/pulls) for an open or closed PR
8279
that relates to your submission. You don't want to duplicate effort.
83-
* Please sign our [Contributor License Agreement (CLA)](#signing-the-cla) before sending pull
84-
requests. We cannot accept code without this.
80+
* Please sign our [Contributor License Agreement (CLA)](#cla) before sending PRs.
81+
We cannot accept code without this.
8582
* Make your changes in a new git branch:
8683

8784
```shell
8885
git checkout -b my-fix-branch master
8986
```
9087

9188
* Create your patch, **including appropriate test cases**.
92-
* Follow our [Coding Rules](#coding-rules).
89+
* Follow our [Coding Rules](#rules).
9390
* Run the full Angular test suite, as described in the [developer documentation][dev-doc],
9491
and ensure that all tests pass.
9592
* Commit your changes using a descriptive commit message that follows our
96-
[commit message conventions](#commit-message-format) and passes our commit message presubmit hook
97-
`validate-commit-msg.js`. Adherence to the [commit message conventions](#commit-message-format)
98-
is required because release notes are automatically generated from these messages.
93+
[commit message conventions](#commit). Adherence to these conventions
94+
is necessary because release notes are automatically generated from these messages.
9995

10096
```shell
10197
git commit -a
@@ -109,7 +105,7 @@ Before you submit your pull request consider the following guidelines:
109105
```
110106

111107
* In GitHub, send a pull request to `angular:master`.
112-
* If we suggest changes then:
108+
* If we suggest changes then:
113109
* Make the required updates.
114110
* Re-run the AngularDart test suite to ensure tests are still passing.
115111
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
@@ -155,10 +151,9 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
155151
156152
* All features or bug fixes **must be tested** by one or more [specs][unit-testing].
157153
* All public API methods **must be documented** with [doc comments][doc-comments].
158-
* With the exceptions listed below, we follow the rules contained in
159-
[Google's Dart Style Guide][dart-style-guide].
154+
* Adhere to the [Google's Dart Style Guide][dart-style-guide].
160155

161-
## <a name="commit"></a> Git Commit Guidelines
156+
## <a name="commit"></a> Commit Message Guidelines
162157

163158
We have very precise rules over how our git commit messages can be formatted. This leads to **more
164159
readable messages** that are easy to follow when looking through the **project history**. But also,
@@ -204,18 +199,18 @@ The subject contains succinct description of the change:
204199
* don't capitalize first letter
205200
* no dot (.) at the end
206201
207-
###Body
202+
### Body
208203
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
209204
The body should include the motivation for the change and contrast this with previous behavior.
210205
211-
###Footer
206+
### Footer
212207
The footer should contain any information about **Breaking Changes** and is also the place to
213208
reference GitHub issues that this commit **Closes**.
214209
215210
216211
A detailed explanation can be found in this [document][commit-message-format].
217212
218-
## <a name="cla"></a> Signing the CLA
213+
## <a name="cla"></a> Signing the CLA
219214
220215
Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code
221216
changes to be accepted, the CLA must be signed. It's a quick process, we promise!
@@ -225,6 +220,7 @@ changes to be accepted, the CLA must be signed. It's a quick process, we promise
225220
[print, sign and one of scan+email, fax or mail the form][corporate-cla].
226221
227222
223+
[angular-group]: https://groups.google.com/forum/#!forum/angular-dart
228224
[coc]: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md
229225
[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
230226
[communityMilestone]: https://github.com/angular/angular.dart/issues?milestone=13&state=open
@@ -233,7 +229,6 @@ changes to be accepted, the CLA must be signed. It's a quick process, we promise
233229
[dev-doc]: https://github.com/angular/angular.dart/blob/master/DEVELOPER.md
234230
[doc-comments]: https://www.dartlang.org/articles/doc-comment-guidelines/
235231
[github]: https://github.com/angular/angular.dart
236-
[groups]: https://groups.google.com/forum/#!forum/angular-dart
237232
[individual-cla]: http://code.google.com/legal/individual-cla-v1.0.html
238233
[runnable]: http://runnable.com/
239234
[stackoverflow]: http://stackoverflow.com/questions/tagged/angular.dart

0 commit comments

Comments
 (0)