Commit a0179bf4 authored by Heather Ellsworth's avatar Heather Ellsworth

Add label usage and link to reporting an issue

parent 87790362
......@@ -14,7 +14,7 @@ Working on issues
Issues have an *Assignee* field, which is used for indicating that someone is working on it. Other people can avoid doing the same work if it's already being taken care of. Anyone interested can assign themselves, even the person who filed the issue.
If you are filing an issue, and you know someone else can solve it better than you can, please use the ``@mention`` to bring their attention. Don't assign other people yourself! Let them take a look before taking the responsibility.
If you are :ref:`filing an issue <issues>`, and you know someone else can solve it better than you can, please use the ``@mention`` to bring their attention. Don't assign other people yourself! Let them take a look before taking the responsibility.
If you wish to take up an issue yourself, you will need additional permissions in our GitLab so please reach out in the community/librem-5 Matrix room and ask for a team member to grant you the "Reporter" role for the relevant project.
......
......@@ -57,3 +57,39 @@ Some examples of *other application* issues would be:
* You wish there to be a certain application available for the phone and want to file an issue about it in hopes someone creates it. Please follow the wishlist template provided in the Apps_issues repo when filing out these types of wishlist item issues.
If you would like to work on any of these issues, please see our :ref:`working on issues <working-on-issues>` section.
Using Labels
------------
There are global labels that are available to all projects and there are project-specific labels. Here is some info on the available labels and their suggested usage.
Global Labels
^^^^^^^^^^^^^
To gauge how serious the issue is, we've provided severity labels that correspond to the same `bug severities used by Debian <https://www.debian.org/Bugs/Developer#severities>`_:
* **critical** - makes unrelated software on the system (or the whole system) break, or causes serious data loss, or introduces a security hole on systems where you install the package
* **grave** - makes the package in question unusable or mostly so, or causes data loss, or introduces a security hole allowing access to the accounts of users who use the package
* **serious** - the package has licensing issues (non-free) or, in the package maintainer's or release manager's opinion, makes the package unsuitable for release
* **important** - a bug which has a major effect on the usability of a package, without rendering it completely unusable to everyone
* **normal** - the default value, applicable to most bugs
* **minor** - a problem which doesn't affect the package's usefulness, and is presumably trivial to fix
* **wishlist** - for any feature request, and also for any bugs that are very difficult to fix due to major design considerations
Please add an appropriate severity label to the issue you are filing.
There are also some other optional labels that are globally available to all projects:
* **upstream** - the issue is an issue in an upstream repository but should still be tracked in the Librem 5 project
* **help_wanted** - anyone can sign up to work on this issue
* **needs_design** - the issue is a good idea but the implementation and next steps needs to be investigated and identified
* **wont_fix** - the issue will not be resolved and a reason should be in the comments
Please add any of the optional labels that make sense for the issue being filed.
Project Labels
^^^^^^^^^^^^^^
Some projects have some project-specific labels defined, most notably the `Apps_issues <https://source.puri.sm/Librem5/Apps_Issues/issues>`_ repository. Because the Apps_issues repo contains issues about many different projects that do not have their own repositories, there are labels created to identify each application. This allows issues that all relate to say a weather application to be grouped under the "weather" label.
Please add any project specific labels that make sense.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment