arsenetar/dupeguru
1
0
Fork 0
mirror of https://github.com/arsenetar/dupeguru.git synced 2025-07-08 16:23:19 +00:00
Code Releases Wiki Activity

Updated issue labels (markdown)

Virgil Dupras 2015-12-26 09:08:29 -05:00
parent 25154b1e56
commit 24c1db7d27
1 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
issue-labels.md → Reporting-issues.md

@ -1,23 +1,36 @@
# Reporting issues
Want to report a bug or suggest a feature? Great, go ahead! To make issue managing easier, please try to follow the guidelines below.
## Duplicates
Please search for duplicates to your issue first. Of course, this is not always easy because it's not everyone who use the same wording for the same problems, but still, please try :)
## Titles
For most issues, the guideline is simply to have a descriptive title. For "crash issues" (issues that you create because you got a traceback), use the last line of the traceback as a title (example: #313).
## Labels
There are 3 kinds of [labels](https://github.com/hsoft/dupeguru/labels) in the [issue system](https://github.com/hsoft/dupeguru/issues), _issue types_, _workflow status_, _UI scope_. There are 3 kinds of [labels](https://github.com/hsoft/dupeguru/labels) in the [issue system](https://github.com/hsoft/dupeguru/issues), _issue types_, _workflow status_, _UI scope_.
Issue types ### Issue types
---
* **[bug](https://github.com/hsoft/dupeguru/labels/bug):** The issue describe a behavior that was never intended and that shouldn't happen. * **[bug](https://github.com/hsoft/dupeguru/labels/bug):** The issue describe a behavior that was never intended and that shouldn't happen.
* **[feature](https://github.com/hsoft/dupeguru/labels/feature):** The issue describe a behavior that isn't present yet but that we wish would be. * **[feature](https://github.com/hsoft/dupeguru/labels/feature):** The issue describe a behavior that isn't present yet but that we wish would be.
* **[docs](https://github.com/hsoft/dupeguru/labels/docs):** The issue describe an improvement to make to the documentation. * **[docs](https://github.com/hsoft/dupeguru/labels/docs):** The issue describe an improvement to make to the documentation.
Workflow status ### Workflow status
---
* **[ready](https://github.com/hsoft/dupeguru/labels/ready):** This issue is ready for implementation. For a feature, that means that we have a clear specification of what to do. For a bug, that means that we have clear steps to reproduce. * **[ready](https://github.com/hsoft/dupeguru/labels/ready):** This issue is ready for implementation. For a feature, that means that we have a clear specification of what to do. For a bug, that means that we have clear steps to reproduce.
* **[mentored](https://github.com/hsoft/dupeguru/labels/mentored):** This ticket is seen as a good introductory task (that is, it should be relatively easy to complete). If you're interested getting involved in the project, it's likely a good place to start. If you need guidance, don't hesitate call for mentors in the [New Contributor issue](https://github.com/hsoft/dupeguru/issues/300). * **[mentored](https://github.com/hsoft/dupeguru/labels/mentored):** This ticket is seen as a good introductory task (that is, it should be relatively easy to complete). If you're interested getting involved in the project, it's likely a good place to start. If you need guidance, don't hesitate call for mentors in the [New Contributor issue](https://github.com/hsoft/dupeguru/issues/300).
* **[hold](https://github.com/hsoft/dupeguru/labels/hold):** Some external feedback is needed to either continue working on the issue, or to close it. Most of the time, it's a bug that can't be reproduced. It needs more details from people who experience the bug so it can be reproduced. * **[hold](https://github.com/hsoft/dupeguru/labels/hold):** Some external feedback is needed to either continue working on the issue, or to close it. Most of the time, it's a bug that can't be reproduced. It needs more details from people who experience the bug so it can be reproduced.
If there aren't any workflow status tag, it means that the issue is still in "discussion" mode and not yet ready to implement. If there aren't any workflow status tag, it means that the issue is still in "discussion" mode and not yet ready to implement (or that it's ready, but we forgot to add the "ready" tag...).
UI Scope ### UI Scope
---
Some issues affect only a subset of all supported UI platforms. In these case, we'll indicate it by applying these tags below.
* **[qt](https://github.com/hsoft/dupeguru/labels/qt):** This issue affects the Qt UI layer. * **[qt](https://github.com/hsoft/dupeguru/labels/qt):** This issue affects the Qt UI layer.
* **[cocoa](https://github.com/hsoft/dupeguru/labels/cocoa):** This issue affects the Cocoa UI layer. * **[cocoa](https://github.com/hsoft/dupeguru/labels/cocoa):** This issue affects the Cocoa UI layer.