Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(296)

Side by Side Diff: third_party/pkg/angular/CONTRIBUTING.md

Issue 256553002: Revert "Update all Angular libs (run update_all.sh)." (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « third_party/pkg/angular/CHANGELOG.md ('k') | third_party/pkg/angular/DEVELOPER.md » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 # Contributing to AngularDart 1 # Contributing to AngularDart
2 2
3 We have set up a [milestone][communityMilestone] for issues that we believe are an excellent 3 We have set up a [milestone][communityMilestone] for issues which we believe are an excellent
4 place to start if you are interested in contributing to AngularDart. 4 place to start if you are interested in contributing to AngularDart.
5 5
6 We'd love for you to contribute to our source code and to make AngularDart even better than it is 6 We'd love for you to contribute to our source code and to make AngularDart even better than it is
7 today! Here are the guidelines we'd like you to follow: 7 today! Here are the guidelines we'd like you to follow:
8 8
9 - [Code of Conduct](#coc) 9 ## Code of Conduct
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
19 Help us keep Angular open and inclusive. Please read and follow our [Code of Con duct][coc]. 10 Help us keep Angular open and inclusive. Please read and follow our [Code of Con duct][coc].
20 11
21 ## <a name="question"></a> Got a Question or Problem? 12 ## Got a Question or Problem?
22 13
23 If you have questions about how to use AngularDart, please direct these to the [ Google Group][groups] 14 If you have questions about how to use AngularDart, please direct these to the [ Google Group][groups]
24 discussion list or [StackOverflow][stackoverflow]. 15 discussion list or [StackOverflow][stackoverflow].
25 16
26 ## <a name="issue"></a> Found an Issue? 17 ## Found an Issue?
27 If you find a bug in the source code or a mistake in the documentation, you can help us by 18 If you find a bug in the source code or a mistake in the documentation, you can help us by
28 submitting and issue to our [GitHub Repository][github]. Even better you can sub mit a Pull Request 19 submitting and issue to our [GitHub Repository][github]. Even better you can sub mit a Pull Request
29 with a fix. 20 with a fix.
30 21
31 **Please see the Submission Guidelines below**. 22 **Please see the Submission Guidelines below**.
32 23
33 ## <a name="feature"></a> Want a Feature? 24 ## Want a Feature?
34 You can request a new feature by submitting an issue to our [GitHub Repository][ github]. If you 25 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: 26 would like to implement a new feature then consider what kind of change it is:
36 27
37 <!-- 28 <!--
38 * **Major Changes** that you wish to contribute to the project should be discuss ed first on our 29 * **Major Changes** that you wish to contribute to the project should be discuss ed first on our
39 [dev mailing list][angular-dev] or [IRC][irc] so that we can better coordinate o ur efforts, prevent 30 [dev mailing list][angular-dev] or [IRC][irc] so that we can better coordinate o ur efforts, prevent
40 duplication of work, and help you to craft the change so that it is successfully accepted into the 31 duplication of work, and help you to craft the change so that it is successfully accepted into the
41 project. 32 project.
42 --> 33 -->
43 * **Small Changes** can be crafted and submitted to [GitHub Repository][github] as a Pull Request. 34 * **Small Changes** can be crafted and submitted to [GitHub Repository][github] as a Pull Request.
44 35
45 36
46 ## <a name="docs"></a> Want a Doc Fix? 37 ## Want a Doc Fix?
47 If you want to help improve the docs, it's a good idea to let others know what y ou're working on to 38 If you want to help improve the docs, it's a good idea to let others know what y ou're working on to
48 minimize duplication of effort. Before starting, check out the issue queue. 39 minimize duplication of effort. Before starting, check out the issue queue.
49 40
50 Comment on an issue to let others know what you're working on, or create a new i ssue if your work 41 Comment on an issue to let others know what you're working on, or create a new i ssue if your work
51 doesn't fit within the scope of any of the existing doc fix projects. 42 doesn't fit within the scope of any of the existing doc fix projects.
52 43
53 For large fixes, please build and test the documentation before submitting the P R to be sure you haven't 44 For large fixes, please build and test the documentation before submitting the P R to be sure you haven't
54 accidentally introduced any layout or formatting issues. You should also make su re that your commit message 45 accidentally introduced any layout or formatting issues.You should also make sur e that your commit message
55 is labeled "docs:" and follows the **Git Commit Guidelines** outlined below. 46 is labeled "docs:" and follows the **Git Commit Guidelines** outlined below.
56 47
57 ## <a name="submit"></a> Submission Guidelines 48 ## Submission Guidelines
58 49
59 ### Submitting an Issue 50 ### Submitting an Issue
60 Before you submit your issue search the archive, maybe your question was already answered. 51 Before you submit your issue search the archive, maybe your question was already answered.
61 52
62 If your issue appears to be a bug, and hasn't been reported, open a new issue. 53 If your issue appears to be a bug, and hasn't been reported, open a new issue.
63 Help us to maximize the effort we can spend fixing issues and adding new 54 Help us to maximize the effort we can spend fixing issues and adding new
64 features, by not reporting duplicate issues. Providing the following informatio n will increase the 55 features, by not reporting duplicate issues. Providing the following informatio n will increase the
65 chances of your issue being dealt with quickly: 56 chances of your issue being dealt with quickly:
66 57
67 * **Overview of the issue** - if an error is being thrown a non-minified stack t race helps 58 * **Overview of the issue** - if an error is being thrown a non-minified stack t race helps
68 * **Motivation for or Use Case** - explain why this is a bug for you 59 * **Motivation for or Use Case** - explain why this is a bug for you
69 * **Angular Version(s)** - is it a regression? 60 * **Angular Version(s)** - is it a regression?
70 * **Browsers and Operating System** - is this a problem with all browsers or onl y IE8? 61 * **Browsers and Operating System** - is this a problem with all browsers or onl y IE8?
71 * **Reproduce the error** - provide a live example (using [Runnable][runnable]) or a unambiguous set of steps. 62 * **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? 63 * **Related issues** - has a similar issue been reported before?
73 * **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point t o what might be 64 * **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point t o what might be
74 causing the problem (line of code or commit) 65 causing the problem (line of code or commit)
75 66
76 **If you get help, help others. Good karma rulez!** 67 **If you get help, help others. Good karma rulez!**
77 68
78 ### Submitting a Pull Request 69 ### Submitting a Pull Request
79 Before you submit your pull request consider the following guidelines: 70 Before you submit your pull request consider the following guidelines:
80 71
81 * Search [GitHub](https://github.com/angular/angular.dart/pulls) for an open or closed Pull Request 72 * Search [GitHub][github] for an open or closed Pull Request
82 that relates to your submission. You don't want to duplicate effort. 73 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 74 * Please sign our [Contributor License Agreement (CLA)](#signing-the-cla) before sending pull
84 requests. We cannot accept code without this. 75 requests. We cannot accept code without this.
85 * Make your changes in a new git branch 76 * Make your changes in a new git branch
86 77
87 ```shell 78 ```shell
88 git checkout -b my-fix-branch master 79 git checkout -b my-fix-branch master
89 ``` 80 ```
90 81
91 * Create your patch, **including appropriate test cases**. 82 * Create your patch, including appropriate test cases.
92 * Follow our [Coding Rules](#coding-rules). 83 * Follow our [Coding Rules](#coding-rules)
93 * Run the full Angular test suite, as described in the [developer documentation] [dev-doc], 84 * Commit your changes and create a descriptive commit message (the
94 and ensure that all tests pass. 85 commit message is used to generate release notes, please check out our
95 * Commit your changes using a descriptive commit message that follows our 86 [commit message conventions](#commit-message-format) and our commit message pr esubmit hook
96 [commit message conventions](#commit-message-format) and passes our commit mes sage presubmit hook 87 `validate-commit-msg.js`):
97 `validate-commit-msg.js`. Adherence to the [commit message conventions](#commi t-message-format)
98 is required because release notes are automatically generated from these messa ges.
99 88
100 ```shell 89 ```shell
101 git commit -a 90 git commit -a
102 ``` 91 ```
103 Note: the optional commit `-a` command line option will automatically "add" an d "rm" edited files.
104 92
105 * Push your branch to GitHub: 93 * Build your changes locally to ensure all the tests pass: see the [developer do cumentation][dev-doc].
94
95 * Push your branch to Github:
106 96
107 ```shell 97 ```shell
108 git push origin my-fix-branch 98 git push origin my-fix-branch
109 ``` 99 ```
110 100
111 * In GitHub, send a pull request to `angular:master`. 101 * In Github, send a pull request to `angular:master`.
112 * If we suggest changes then 102 * If we suggest changes then you can modify your branch, rebase and force a new push to your GitHub
113 * Make the required updates. 103 repository to update the Pull Request:
114 * Re-run the AngularDart test suite to ensure tests are still passing.
115 * Rebase your branch and force push to your GitHub repository (this will updat e your Pull Request):
116 104
117 ```shell 105 ```shell
118 git rebase master -i 106 git rebase master -i
119 git push -f 107 git push -f
120 ``` 108 ```
121 109
122 That's it! Thank you for your contribution! 110 That's it! Thank you for your contribution!
123 111
124 #### After your pull request is merged 112 When the patch is reviewed and merged, you can safely delete your branch and pul l the changes
125
126 After your pull request is merged, you can safely delete your branch and pull th e changes
127 from the main (upstream) repository: 113 from the main (upstream) repository:
128 114
129 * Delete the remote branch on GitHub either through the GitHub web UI or your lo cal shell as follows: 115 * Delete the remote branch on Github:
130 116
131 ```shell 117 ```shell
132 git push origin --delete my-fix-branch 118 git push origin --delete my-fix-branch
133 ``` 119 ```
134 120
135 * Check out the master branch: 121 * Check out the master branch:
136 122
137 ```shell 123 ```shell
138 git checkout master -f 124 git checkout master -f
139 ``` 125 ```
140 126
141 * Delete the local branch: 127 * Delete the local branch:
142 128
143 ```shell 129 ```shell
144 git branch -D my-fix-branch 130 git branch -D my-fix-branch
145 ``` 131 ```
146 132
147 * Update your master with the latest upstream version: 133 * Update your master with the latest upstream version:
148 134
149 ```shell 135 ```shell
150 git pull --ff upstream master 136 git pull --ff upstream master
151 ``` 137 ```
152 138 ## Coding Rules
153 ## <a name="rules"></a> Coding Rules
154 To ensure consistency throughout the source code, keep these rules in mind as yo u are working: 139 To ensure consistency throughout the source code, keep these rules in mind as yo u are working:
155 140
156 * All features or bug fixes **must be tested** by one or more [specs][unit-tes ting]. 141 * All features or bug fixes **must be tested** by one or more [specs][unit-tes ting].
157 * All public API methods **must be documented** with [doc comments][doc-commen ts]. 142 * All public API methods **must be documented** with [doc comments][doc-commen ts].
158 * With the exceptions listed below, we follow the rules contained in 143 * With the exceptions listed below, we follow the rules contained in
159 [Google's Dart Style Guide][dart-style-guide]. 144 [Google's Dart Style Guide][dart-style-guide].
160 145
161 ## <a name="commit"></a> Git Commit Guidelines 146 ## Git Commit Guidelines
162 147
163 We have very precise rules over how our git commit messages can be formatted. T his leads to **more 148 We have very precise rules over how our git commit messages can be formatted. T his leads to **more
164 readable messages** that are easy to follow when looking through the **project h istory**. But also, 149 readable messages** that are easy to follow when looking through the **project h istory**. But also,
165 we use the git commit messages to **generate the AngularDart change log**. 150 we use the git commit messages to **generate the AngularDart change log**.
166 151
167 ### Commit Message Format 152 ### Commit Message Format
168 Each commit message consists of a **header**, a **body** and a **footer**. The header has a special 153 Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
169 format that includes a **type**, a **scope** and a **subject**: 154 format that includes a **type**, a **scope** and a **subject**:
170 155
171 ``` 156 ```
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after
208 Just as in the **subject**, use the imperative, present tense: "change" not "cha nged" nor "changes" 193 Just as in the **subject**, use the imperative, present tense: "change" not "cha nged" nor "changes"
209 The body should include the motivation for the change and contrast this with pre vious behavior. 194 The body should include the motivation for the change and contrast this with pre vious behavior.
210 195
211 ###Footer 196 ###Footer
212 The footer should contain any information about **Breaking Changes** and is also the place to 197 The footer should contain any information about **Breaking Changes** and is also the place to
213 reference GitHub issues that this commit **Closes**. 198 reference GitHub issues that this commit **Closes**.
214 199
215 200
216 A detailed explanation can be found in this [document][commit-message-format]. 201 A detailed explanation can be found in this [document][commit-message-format].
217 202
218 ## <a name="cla"></a> Signing the CLA 203 ## Signing the CLA
219 204
220 Please sign our Contributor License Agreement (CLA) before sending pull requests . For any code 205 Please sign our Contributor License Agreement (CLA) before sending pull requests . For any code
221 changes to be accepted, the CLA must be signed. It's a quick process, we promise ! 206 changes to be accepted, the CLA must be signed. It's a quick process, we promise !
222 207
223 * For individuals we have a [simple click-through form][individual-cla]. 208 * For individuals we have a [simple click-through form][individual-cla].
224 * For corporations we'll need you to 209 * For corporations we'll need you to
225 [print, sign and one of scan+email, fax or mail the form][corporate-cla]. 210 [print, sign and one of scan+email, fax or mail the form][corporate-cla].
226 211
227 212
228 [coc]: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md 213 [groups]: https://groups.google.com/forum/#!forum/angular-dart
214 [stackoverflow]: http://stackoverflow.com/questions/tagged/angular.dart
215 [github]: https://github.com/angular/angular.dart
216 [runnable]: http://runnable.com/
217 [unit-testing]: https://www.dartlang.org/articles/dart-unit-tests/
218 [doc-comments]: https://www.dartlang.org/articles/doc-comment-guidelines/
219 [dart-style-guide]: https://www.dartlang.org/articles/idiomatic-dart/
220 [individual-cla]: http://code.google.com/legal/individual-cla-v1.0.html
221 [corporate-cla]: http://code.google.com/legal/corporate-cla-v1.0.html
229 [commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15I JygNPiHORgU1_OOAqWjiDU5Y/edit# 222 [commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15I JygNPiHORgU1_OOAqWjiDU5Y/edit#
230 [communityMilestone]: https://github.com/angular/angular.dart/issues?milestone=1 3&state=open 223 [communityMilestone]: https://github.com/angular/angular.dart/issues?milestone=1 3&state=open
231 [corporate-cla]: http://code.google.com/legal/corporate-cla-v1.0.html 224 [coc]: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md
232 [dart-style-guide]: https://www.dartlang.org/articles/idiomatic-dart/
233 [dev-doc]: https://github.com/angular/angular.dart/blob/master/DEVELOPER.md 225 [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/
OLDNEW
« no previous file with comments | « third_party/pkg/angular/CHANGELOG.md ('k') | third_party/pkg/angular/DEVELOPER.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698