StarMirror/qTox
1
0
Fork 0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
Code Issues Projects Releases Wiki Activity

style: enhance and reformat issue template

Browse Source 
Add missing required information for new issues
Redo Markdown format for a cleaner raw display
Standarise requirements/terms with CONTRIBUTING.md
This commit is contained in:
kehugter 2016-04-08 10:04:19 +02:00
parent 93d69a0009
commit da58b65059
2 changed files with 24 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -4,15 +4,14 @@
* If you aren't sure, you can ask on the [**IRC channel**](https://webchat.freenode.net/?channels=qtox) or read our [**wiki**](https://github.com/tux3/qTox/wiki) first. * If you aren't sure, you can ask on the [**IRC channel**](https://webchat.freenode.net/?channels=qtox) or read our [**wiki**](https://github.com/tux3/qTox/wiki) first.
* Do a quick **search**. Others might have already reported the issue. * Do a quick **search**. Others might have already reported the issue.
* Write in **English**! * Write in **English**!
* Provide **version** information: (You can find version numbers in menu `Settings → About`) * Provide **version** information (you can find version numbers in menu `Settings → About`):
``` ```
qTox: OS:
qTox version:
Commit hash: Commit hash:
toxcore: toxcore:
Qt: Qt:
OS version: ```
```
* Provide **steps** to reproduce the problem, it will be easier to pinpoint the fault. * Provide **steps** to reproduce the problem, it will be easier to pinpoint the fault.
* **Screenshots**! A screenshot is worth a thousand words. Just upload it. [(How?)](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests) * **Screenshots**! A screenshot is worth a thousand words. Just upload it. [(How?)](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests)
@ -25,7 +24,7 @@ OS version:
# Opening a pull request # Opening a pull request
### Must read ### Must read
* Use **[commit message format](#commit-message-format)**. * Use [**commit message format**](#commit-message-format).
* Read our [**coding guidelines**](https://github.com/tux3/qTox/wiki/Coding). * Read our [**coding guidelines**](https://github.com/tux3/qTox/wiki/Coding).
* Keep the title **short** and provide a **clear** description about what your pull request does. * Keep the title **short** and provide a **clear** description about what your pull request does.
* Provide **screenshots** for UI related changes. * Provide **screenshots** for UI related changes.

33
ISSUE_TEMPLATE.md
View File

@ -1,29 +1,32 @@
Brief description: #### Brief Description
Operating System: Windows / OS X / Linux (include version and/or distro) OS: Windows / OS X / Linux (include version and/or distro)
qTox version: (shown on `About` page in settings) qTox version: (version numbers in menu `Settings → About`)
Hardware: Commit hash:
toxcore:
Qt:
Hardware:
… …
Reproducible: Always / Almost Always / Sometimes / Rarely / Couldn't Reproduce Reproducible: Always / Almost Always / Sometimes / Rarely / Couldn't Reproduce
#### Steps to reproduce
**Steps to reproduce:** 1.
1. 2.
2. 3. …
3.
… #### Observed Behavior
**Observed Behavior:** #### Expected Behavior
**Expected Behavior:** #### Additional Info
**Additional info:**
(links, images, etc go here) (links, images, etc go here)
---- ----
More information on how to write good bug reports in the wiki: https://github.com/tux3/qTox/wiki/Writing-Useful-Bug-Reports More information on how to write good bug reports in the wiki: https://github.com/tux3/qTox/wiki/Writing-Useful-Bug-Reports.
Please remove any unnecessary template section before submitting.