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