Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit b837a31

Browse files
docs(CONTRIBUTING): highlight what makes a good issue submission
1 parent 66b0fcd commit b837a31

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

CONTRIBUTING.md

+18-8
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,29 @@ project.
3232
## Submission Guidelines
3333

3434
### Submitting an Issue
35-
Before you submit your issue follow the following guidelines:
36-
37-
* Search the archive first, it's likely that your question was already answered.
38-
* A live example demonstrating the issue, will get an answer faster.
39-
* Create one using [Plunker][plunker] or [JSFiddle][jsfiddle].
40-
* If you get help, help others. Good karma rulez!
35+
Before you submit your issue, search the archive, it's maybe your question was already answered.
4136

4237
If your issue appears to be a bug, and hasn't been reported, open a new issue.
4338
Help us to maximize the effort we can spend fixing issues and adding new
44-
features, by not reporting duplicate issues.
39+
features, by not reporting duplicate issues. Providing the following information will increase the
40+
chances of your issue being dealt with quickly:
41+
42+
* **Overview of the issue** - if an error is being thrown a non-minified stack trace helps
43+
* **Motivation for or Use Case** - explain why this is a bug for you
44+
* **Angular Version(s)** - is it a regression?
45+
* **Browsers and Operating System** - is this a problem with all browsers or only IE8?
46+
* **Reproduce the error** - provide a live example (using [Plunker][plunker] or
47+
[JSFiddle][jsfiddle]) or a unambiguous set of steps.
48+
* **Related issues** - has a similar issue been reported before?
49+
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
50+
causing the problem (line of code or commit)
51+
52+
Here is a great example of a well defined issue: https://github.com/angular/angular.js/issues/5069
53+
54+
**If you get help, help others. Good karma rulez!**
4555

4656
### Submitting a Pull Request
47-
Before you submit your pull request follow the following guidelines:
57+
Before you submit your pull request consider the following guidelines:
4858

4959
* Search [GitHub](https://github.com/angular/angular.js/pulls) for an open or closed Pull Request
5060
that relates to your submission. You don't want to duplicate effort.

0 commit comments

Comments
 (0)