Skip to content
This repository was archived by the owner on Oct 2, 2019. It is now read-only.

Commit 3833c9f

Browse files
committed
chore(contributing): update contributing doc and issue template
Closes #1494
1 parent 161cff5 commit 3833c9f

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

.github/ISSUE_TEMPLATE.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
The issues forum is __NOT__ for support requests. It is for bugs and feature requests only.
2+
Please read https://github.com/angular-ui/ui-select/blob/master/CONTRIBUTING.md and search
3+
existing issues (both open and closed) prior to opening any new issue and ensure you follow the instructions therein.
4+
5+
### Bug description:
6+
7+
### Link to minimally-working plunker that reproduces the issue:
8+
9+
### Version of Angular, UI-Select, and Bootstrap/Select2/Selectize CSS
10+
11+
Angular:
12+
13+
UI-Select:
14+
15+
Bootstrap/Select2/Selectize CSS (if applicable):

CONTRIBUTING.md

+31
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,39 @@
11
We are excited to have you working on the project and cordially request that you follow the Guidelines:
22

3+
- [Got a question or problem?](#question)
4+
- [You think you've found a bug?](#bug)
35
- [Code Style Guidelines](#rules)
46
- [Commit Message Guidelines](#commit)
57

8+
## <a name="question"></a> Got a question or problem?
9+
10+
Firstly, please go over our FAQ: https://github.com/angular-ui/ui-select/wiki/FAQs
11+
12+
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-select) where maintainers are looking at questions tagged with `angular-ui-select`.
13+
14+
StackOverflow is a much better place to ask questions since:
15+
* there are hundreds of people willing to help on StackOverflow
16+
* questions and answers stay available for public viewing so your question / answer might help someone else
17+
* SO voting system assures that the best answers are prominently visible.
18+
19+
To save your and our time we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.
20+
21+
## <a name="bug"></a> You think you've found a bug?
22+
23+
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 wealth of important information without going back & forth to you with additional questions like:
24+
* version of AngularJS used
25+
* version of this library that you are using
26+
* 3rd-party libraries used, if any
27+
* and most importantly - a use-case that fails
28+
29+
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.
30+
31+
We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves 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.
32+
33+
The best part is that you don't need to create plunks from scratch - you can use one from our [demo page](http://plnkr.co/edit/a3KlK8dKH3wwiiksDSn2?p=preview).
34+
35+
Unfortunately 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.
36+
637
## <a name="rules"></a> Coding Rules
738
To ensure consistency throughout the source code, keep these rules in mind as you are working:
839

0 commit comments

Comments
 (0)