You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Comment on an issue to let others know what you're working on, or create a new issue if your work
54
-
doesn't fit within the scope of any of the existing doc fix projects.
57
+
minimize duplication of effort. Create a new issue (or comment on a related existing one) to let
58
+
others know what you're working on.
55
59
56
-
For large fixes, please build and test the documentation before submitting the PR to be sure you haven't
57
-
accidentally introduced any layout or formatting issues. You should also make sure that your commit message
58
-
is labeled "docs:" and follows the **Git Commit Guidelines** outlined below.
60
+
For large fixes, please build and test the documentation before submitting the PR to be sure you
61
+
haven't accidentally introduced any layout or formatting issues. You should also make sure that your
62
+
commit message starts with "docs" and follows the **[Commit Message Guidelines](#commit)** outlined
63
+
below.
59
64
60
-
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.
65
+
If you're just making a small change, don't worry about filing an issue first. Use the friendly blue
66
+
"Improve this doc" button at the top right of the doc page to fork the repository in-place and make
67
+
a quick change on the fly. When naming the commit, it is advised to follow the commit message
68
+
guidelines below, by starting the commit message with **docs** and referencing the filename. Since
69
+
this is not obvious and some changes are made on the fly, this is not strictly necessary and we will
70
+
understand if this isn't done the first few times.
61
71
62
72
## <aname="submit"></a> Submission Guidelines
63
73
64
74
### Submitting an Issue
65
75
Before you submit your issue search the archive, maybe your question was already answered.
66
76
67
-
If your issue appears to be a bug, and hasn't been reported, open a new issue.
68
-
Help us to maximize the effort we can spend fixing issues and adding new
69
-
features, by not reporting duplicate issues. Providing the following information will increase the
70
-
chances of your issue being dealt with quickly:
77
+
If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize
78
+
the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
79
+
Providing the following information will increase the chances of your issue being dealt with
80
+
quickly:
71
81
72
82
***Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
73
83
***Motivation for or Use Case** - explain why this is a bug for you
74
84
***Angular Version(s)** - is it a regression?
75
-
***Browsers and Operating System** - is this a problem with all browsers or only IE8?
85
+
***Browsers and Operating System** - is this a problem with all browsers or only specific ones?
76
86
***Reproduce the Error** - provide a live example (using [Plunker][plunker] or
77
87
[JSFiddle][jsfiddle]) or an unambiguous set of steps.
78
88
***Related Issues** - has a similar issue been reported before?
@@ -92,22 +102,22 @@ Before you submit your pull request consider the following guidelines:
92
102
requests. We cannot accept code without this.
93
103
* Make your changes in a new git branch:
94
104
95
-
```shell
96
-
git checkout -b my-fix-branch master
97
-
```
105
+
```shell
106
+
git checkout -b my-fix-branch master
107
+
```
98
108
99
109
* Create your patch, **including appropriate test cases**.
100
110
* Follow our [Coding Rules](#rules).
101
111
* Run the full Angular test suite, as described in the [developer documentation][dev-doc],
102
112
and ensure that all tests pass.
103
113
* Commit your changes using a descriptive commit message that follows our
104
-
[commit message conventions](#commit-message-format) and passes our commit message presubmit hook
105
-
`validate-commit-msg.js`. Adherence to the [commit message conventions](#commit-message-format)
106
-
is required because release notes are automatically generated from these messages.
114
+
[commit message conventions](#commit) and passes our commit message presubmit hook
115
+
(`validate-commit-msg.js`). Adherence to the [commit message conventions](#commit) is required,
116
+
because release notes are automatically generated from these messages.
107
117
108
-
```shell
109
-
git commit -a
110
-
```
118
+
```shell
119
+
git commit -a
120
+
```
111
121
Note: the optional commit `-a`command line option will automatically "add" and "rm" edited files.
112
122
113
123
* Build your changes locally to ensure all the tests pass:
@@ -122,12 +132,13 @@ Before you submit your pull request consider the following guidelines:
122
132
git push origin my-fix-branch
123
133
```
124
134
125
-
* In GitHub, send a pull request to `angular:master`.
126
-
* If we suggest changes then:
127
-
* Make the required updates.
128
-
* Re-run the Angular test suite to ensure tests are still passing.
129
-
* Commit your changes to your branch (e.g. `my-fix-branch`).
130
-
* Push the changes to your GitHub repository (this will update your Pull Request).
135
+
In GitHub, send a pull request to `angular:master`.
136
+
If we suggest changes, then:
137
+
138
+
* Make the required updates.
139
+
* Re-run the Angular test suite to ensure tests are still passing.
140
+
* Commit your changes to your branch (e.g. `my-fix-branch`).
141
+
* Push the changes to your GitHub repository (this will update your Pull Request).
131
142
132
143
If the PR gets too outdated we may ask you to rebase and force push to update the PR:
133
144
@@ -136,8 +147,9 @@ git rebase master -i
136
147
git push origin my-fix-branch -f
137
148
```
138
149
139
-
*WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments
140
-
on code that were previously made by you and others in your commits.*
150
+
_WARNING: Squashing or reverting commits and force-pushing thereafter may remove GitHub comments
151
+
on code that were previously made by you or others in your commits. Avoid any form of rebasing
152
+
unless necessary._
141
153
142
154
That's it! Thank you for your contribution!
143
155
@@ -171,6 +183,7 @@ from the main (upstream) repository:
171
183
```
172
184
173
185
## <a name="rules"></a> Coding Rules
186
+
174
187
To ensure consistency throughout the source code, keep these rules in mind as you are working:
175
188
176
189
* All features or bug fixes **must be tested** by one or more [specs][unit-testing].
0 commit comments