Skip to content

Commit 9030d2c

Browse files
docs(CONTRIBUTING.md): clarify GitHub issues handling policy
1 parent 7512b93 commit 9030d2c

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
1+
## Got a question or problem?
2+
3+
Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on (StackOverflow)[http://stackoverflow.com/questions/tagged/angular-ui-bootstrap] where maintainers are looking at questions questions tagged with `angular-ui-bootstrap`.
4+
5+
StackOverflow is a much better place to ask questions since:
6+
* there are hundereds of people willing to help on StackOverflow
7+
* questions and answers stay available for public viewing so your question / answer might help someone else
8+
* SO voting system assures that the best answers are prominently visible.
9+
10+
To save your and our time we will be systematically closing all the issues that are request for general support and redirecting people to StackOverflow.
11+
12+
## You think you've found a bug?
13+
14+
Oh, we are ashamed and want to fix it asap! But before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a _minimal_ reproduce scenario using http://plnkr.co/. Having a live reproduce scenario gives us welth of important information without going back & forth to you with additional questions like:
15+
* version of AngularJS used
16+
* version of this library that you are using
17+
* 3rd-party libraries used, if any
18+
* and most importantly - a use-case that fails
19+
20+
A minimal reproduce scenario using http://plnkr.co/ allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem.
21+
22+
We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimatelly be able to fix more bugs. Interestingly, from our experience users often find coding problems theimselves while preparing a minimal plunk. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.
23+
24+
The best part is that you don't need to create plunks from scractch - you can for one from our [demo page](http://angular-ui.github.io/bootstrap/).
25+
26+
Unfortunatelly we are not able to investigate / fix bugs without a minimal reproduce scenario using http://plnkr.co/, so if we don't hear back from you we are going to close an issue that don't have enough info to be reproduced.
27+
28+
29+
## You want to contribute some code?
30+
131
We are always looking for the quality contributions and will be happy to accept your Pull Requests as long as those adhere to some basic rules:
232

333
* Please make sure that your contribution fits well in the project's context:

0 commit comments

Comments
 (0)