Labels proposal - Umcaruje/lmms GitHub Wiki

###Labels Proposal v0.3 by @Umcaruje

Basic Labels:
By issue type: bug enhancement
By issue domain: core gui ux
Special Labels:
critical For bugs that need a fix asap and are blocking regular development.
needs clarification For poorly written issues that are not understandable / incomplete.
support request For issues that aren't really issues, but users reaching out for help.
meta For issues consisting of an amount of smaller issues.
not our bug For issues that aren't actually related to LMMS.
duplicate For issues that already exist.
invalid For non-reproducible issues.
won't fix Valid issues that won't be addressed, for whatever reason

If an issue is valid, confirmed and is well written, and is inside the scope, it should be labeled bug or enhancement, if it does not match that criteria, that means its either a support request, invalid, a duplicate or it needs clarification.

Guidelines for writing proper issues:

Before posting your issue on the LMMS issue tracker, always use the search function to check out if someone has reported the same thing you wanted to post, so we avoid duplicate issues on the tracker.

A well written issue:

  • Has correct spelling and grammar, and is as clear and concise as possible
  • Is not very broad and should be focusing on only one problem (exceptions are the meta issues which bind several issues together)
  • Does not have excessive formatting, as it greatly reduces readability
  • When entered to google translate it shouldn't leave a single word untranslated

A proper bug report:

  • Should be clear and concise, with as much good grammar as possible
  • Should have exact steps to reproduce the reported problem
  • If applicable, a backtrace of a crash should be included
  • Backtraces must be wrapped up in code brackets ( ``` ) to avoid linking to non-related issues
  • Longer backtraces (>40 lines) must be gisted rather than pasted in the report, to improve readability

What is the order in which issues should be solved?

  • Issues with the critical label are of the highest priority and should be solved as soon as possible.
  • Issues that have a milestone have a higher priority than non-milestoned issues. The lower the milestone version number, the higher the priority.
  • Bugs have a higher priority than enhancements