on master help sign in
Merge pull request #3981 from ahmadsalim/contribution/issue-reporting-update

Updated contributing for issues and added issue template

commit7bf6cde869e4a7a0620bf7a20cc1ed703323f34e authorAhmad Salim Al-Sibahi <asal@itu.dk> dateSat 5 Aug 2017, 18:48 (9 years ago) parent5e0301c725605f
2 files changed+24
.github/ISSUE_TEMPLATE.md+9 CONTRIBUTING.md+15
.github/ISSUE_TEMPLATE.mdnew file+9
@@ -0,0 +1,9 @@
1+Please attach complete source files that exhibit the issue in addition
2+to quoting from them here.
3+
4+# Steps to Reproduce
5+
6+# Expected Behavior
7+
8+# Observed Behavior
9+
CONTRIBUTING.md+15
@@ -20,6 +20,21 @@ Here are a few guidelines that we would like contributors to follow so that we c
2020Before you report an issue, or wish to add cool functionality please try and check to see if there are existing [issues](https://github.com/idris-lang/Idris-dev/issues) and [pull requests](https://github.com/idris-lang/Idris-dev/pulls).
2121We do not want you wasting your time, duplicating somebody's work!
2222
23+### Template
24+Try as closely as possible to describe the issue, ensuring that it has sections that match the following headings:
25+> \# Steps to Reproduce
26+>
27+> \# Expected Behavior
28+>
29+> \# Observed Behavior
30+>
31+>
32+
33+In addition, please attach complete source files that exhibit the issue to quoting from them in the issue.
34+
35+### Feature Requests
36+We would be delighted to receive feature requests only if they are feasible to implement and the author is willing to implement the suggested features themself. The current Idris developer team consists mostly of volunteers, and so it is unfortunately hard to accommodate implementing nice-to-have ideas that are not essential for core language development.
37+
2338## The Campsite Rule
2439
2540We try to follow the **campsite rule**: leave the code base in better condition than you found it.