diff options
| author |  Lubomir I. Ivanov <neolit123@gmail.com> | 2017-09-25 01:10:04 +0300 |
|---|---|---|
| committer | Lubomir I. Ivanov <neolit123@gmail.com> | 2017-09-26 20:45:07 +0300 |
| commit | 73814583258fd88078582043754dc5fa33861cbf (patch) | |
| tree | 4e9b37278bd77c1d363100a2f28c0ee63a0f8529 /.github/ISSUE_TEMPLATE.md | |
| parent | f0de9e77b87691c331f17c84ad7f3d0d40ff9f1d (diff) | |
| download | subsurface-73814583258fd88078582043754dc5fa33861cbf.tar.gz | |
github: add templates for pull requests and issue reports
.github/ISSUE_TEMPLATE.md will be used when the Github users
create new issues.
.github/PULL_REQUEST_TEMPLATE.md will be used when the Github users
create new pull requests.
The markdown supports HTML comments (<!-- comment -->), which
can instruct the Github user how to create a detailed PR or issue
report.
Most big Github projects use such templates and these can help
the collaborators to examine the PRs and ISSUES faster.
Fixes #598
Reviewed-by: Dirk Hohndel <dirk@hohndel.org>
Reviewed-by: Jan Mulder <jlmulder@xs4all.nl>
Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Diffstat (limited to '.github/ISSUE_TEMPLATE.md')
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..cdef9330d --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,40 @@ +<!-- Lines like this one are comments and will not be shown in the final output. --> +<!-- If you are a collaborator, please add labels and assign other collaborators for a review. --> + +### Describe the issue: +<!-- Replace [ ] with [x] to select options. --> +- [ ] Bug +- [ ] Change request +- [ ] New feature request +- [ ] Discussion request + +### Issue long description: +<!-- Describe the issue in detail. --> + +### Operating system: +<!-- What OS are you running? --> +<!-- What is the OS version? --> +<!-- What device are you using? --> +<!-- Does the same happen on another OS? --> + +### Subsurface version: +<!-- What version of Subsurface are you running? --> +<!-- Does the same happen on another Subsurface version? --> +<!-- Are you using official release, test build, or compiled yourself? --> +<!-- Provide Git hash if your are building Subsurface yourself. --> + +### Steps to reproduce: +<!-- Provide reproduction steps separated with new lines - 1), 2), 3)... --> + +### Current behavior: +<!-- What is the current behavior? --> + +### Expected behavior: +<!-- What is the expected behavior? --> + +### Additional information: +<!-- If a simple dive log file can reproduce the issue, please attach that to the report. --> +<!-- With dive computer download issues consider adding Subsurface log file and Subsurface dumpfile to the report. --> + +### Mentions: +<!-- Mention users that you want to review your issue with @<user-name>. Leave empty if not sure. --> |