Skip to content

Commit 409a3ed

Browse files
committed
Adding Submitting Issues Verbiage
1 parent 6a59e2a commit 409a3ed

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,23 @@ Detailed Documentation
3737

3838
**angular-parallax** accepts several attributes to customize the behavior of the directive; detailed instructions coming soon
3939

40+
Submitting Issues
41+
----------------------
42+
43+
If your issue appears to be a bug, and hasn't been reported, open a new issue. Providing the following information will increase the chances of your issue being dealt with quickly:
44+
45+
* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
46+
* **Motivation for or Use Case** - explain why this is a bug for you
47+
* **Angular Parallax Version(s)** - is it a regression?
48+
* **Browsers and Operating System** - is this a problem with all browsers or only IE8?
49+
* **Reproduce the Error** - provide a live example (using [Plunker](http://plnkr.co/),
50+
[JSFiddle](http://jsfiddle.net/), or [CodePen](http://codepen.io/)).
51+
* **Related Issues** - has a similar issue been reported before?
52+
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
53+
causing the problem (line of code or commit)
54+
55+
Here is a great example of a well defined issue: https://github.com/angular/angular.js/issues/5069
56+
4057
License
4158
-------
4259

0 commit comments

Comments
 (0)