Skip to content
This repository was archived by the owner on Feb 22, 2018. It is now read-only.

Commit 40ec82e

Browse files
chalinmhevery
authored andcommitted
chore(CONTRIBUTING): merge relevant updates from Angular.js
Port changes to Angular.js CONTRIBUTING.md since AngularDart version was forked. Closes #748
1 parent 1571459 commit 40ec82e

File tree

1 file changed

+31
-21
lines changed

1 file changed

+31
-21
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,31 @@ place to start if you are interested in contributing to AngularDart.
66
We'd love for you to contribute to our source code and to make AngularDart even better than it is
77
today! Here are the guidelines we'd like you to follow:
88

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

12-
## Got a Question or Problem?
21+
## <a name="question"></a> Got a Question or Problem?
1322

1423
If you have questions about how to use AngularDart, please direct these to the [Google Group][groups]
1524
discussion list or [StackOverflow][stackoverflow].
1625

17-
## Found an Issue?
26+
## <a name="issue"></a> Found an Issue?
1827
If you find a bug in the source code or a mistake in the documentation, you can help us by
1928
submitting and issue to our [GitHub Repository][github]. Even better you can submit a Pull Request
2029
with a fix.
2130

2231
**Please see the Submission Guidelines below**.
2332

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

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

3645

37-
## Want a Doc Fix?
46+
## <a name="docs"></a> Want a Doc Fix?
3847
If you want to help improve the docs, it's a good idea to let others know what you're working on to
3948
minimize duplication of effort. Before starting, check out the issue queue.
4049

@@ -45,7 +54,7 @@ For large fixes, please build and test the documentation before submitting the P
4554
accidentally introduced any layout or formatting issues. You should also make sure that your commit message
4655
is labeled "docs:" and follows the **Git Commit Guidelines** outlined below.
4756

48-
## Submission Guidelines
57+
## <a name="submit"></a> Submission Guidelines
4958

5059
### Submitting an Issue
5160
Before you submit your issue search the archive, maybe your question was already answered.
@@ -69,7 +78,7 @@ chances of your issue being dealt with quickly:
6978
### Submitting a Pull Request
7079
Before you submit your pull request consider the following guidelines:
7180

72-
* Search [GitHub][github] for an open or closed Pull Request
81+
* Search [GitHub](https://github.com/angular/angular.dart/pulls) for an open or closed Pull Request
7382
that relates to your submission. You don't want to duplicate effort.
7483
* Please sign our [Contributor License Agreement (CLA)](#signing-the-cla) before sending pull
7584
requests. We cannot accept code without this.
@@ -81,7 +90,7 @@ Before you submit your pull request consider the following guidelines:
8190

8291
* Create your patch, **including appropriate test cases**.
8392
* Follow our [Coding Rules](#coding-rules).
84-
* Run the full AngularDart test suite, as described in the [developer documentation][dev-doc],
93+
* Run the full Angular test suite, as described in the [developer documentation][dev-doc],
8594
and ensure that all tests pass.
8695
* Commit your changes using a descriptive commit message that follows our
8796
[commit message conventions](#commit-message-format) and passes our commit message presubmit hook
@@ -92,6 +101,7 @@ Before you submit your pull request consider the following guidelines:
92101
git commit -a
93102
```
94103
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
104+
95105
* Push your branch to GitHub:
96106

97107
```shell
@@ -140,15 +150,15 @@ from the main (upstream) repository:
140150
git pull --ff upstream master
141151
```
142152
143-
## Coding Rules
153+
## <a name="rules"></a> Coding Rules
144154
To ensure consistency throughout the source code, keep these rules in mind as you are working:
145155
146156
* All features or bug fixes **must be tested** by one or more [specs][unit-testing].
147157
* All public API methods **must be documented** with [doc comments][doc-comments].
148158
* With the exceptions listed below, we follow the rules contained in
149159
[Google's Dart Style Guide][dart-style-guide].
150160

151-
## Git Commit Guidelines
161+
## <a name="commit"></a> Git Commit Guidelines
152162

153163
We have very precise rules over how our git commit messages can be formatted. This leads to **more
154164
readable messages** that are easy to follow when looking through the **project history**. But also,
@@ -205,7 +215,7 @@ reference GitHub issues that this commit **Closes**.
205215
206216
A detailed explanation can be found in this [document][commit-message-format].
207217
208-
## Signing the CLA
218+
## <a name="cla"></a> Signing the CLA
209219
210220
Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code
211221
changes to be accepted, the CLA must be signed. It's a quick process, we promise!
@@ -215,16 +225,16 @@ changes to be accepted, the CLA must be signed. It's a quick process, we promise
215225
[print, sign and one of scan+email, fax or mail the form][corporate-cla].
216226
217227
218-
[groups]: https://groups.google.com/forum/#!forum/angular-dart
219-
[stackoverflow]: http://stackoverflow.com/questions/tagged/angular.dart
220-
[github]: https://github.com/angular/angular.dart
221-
[runnable]: http://runnable.com/
222-
[unit-testing]: https://www.dartlang.org/articles/dart-unit-tests/
223-
[doc-comments]: https://www.dartlang.org/articles/doc-comment-guidelines/
224-
[dart-style-guide]: https://www.dartlang.org/articles/idiomatic-dart/
225-
[individual-cla]: http://code.google.com/legal/individual-cla-v1.0.html
226-
[corporate-cla]: http://code.google.com/legal/corporate-cla-v1.0.html
228+
[coc]: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md
227229
[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
228230
[communityMilestone]: https://github.com/angular/angular.dart/issues?milestone=13&state=open
229-
[coc]: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md
231+
[corporate-cla]: http://code.google.com/legal/corporate-cla-v1.0.html
232+
[dart-style-guide]: https://www.dartlang.org/articles/idiomatic-dart/
230233
[dev-doc]: https://github.com/angular/angular.dart/blob/master/DEVELOPER.md
234+
[doc-comments]: https://www.dartlang.org/articles/doc-comment-guidelines/
235+
[github]: https://github.com/angular/angular.dart
236+
[groups]: https://groups.google.com/forum/#!forum/angular-dart
237+
[individual-cla]: http://code.google.com/legal/individual-cla-v1.0.html
238+
[runnable]: http://runnable.com/
239+
[stackoverflow]: http://stackoverflow.com/questions/tagged/angular.dart
240+
[unit-testing]: https://www.dartlang.org/articles/dart-unit-tests/

0 commit comments

Comments
 (0)