Commit ff03512e authored by Heather Ellsworth's avatar Heather Ellsworth

Add issue templates

parent 01e12e0e
......@@ -13,7 +13,7 @@ Some common scenarios would be:
.. note:: Remember that to avoid duplicate issues, you should *always* search for the existing issue first before filing a new one.
Issue in the Operating System
-----------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Issues for the **base OS** will be tracked in `OS_issues <https://source.puri.sm/Librem5/OS_issues/issues>`_. Your issue would go here if you have a concern with something that is *not application specific*.
......@@ -23,8 +23,10 @@ Some examples would be:
* kernel crashes
* trouble installing packages
Please follow the :ref:`problem-issue-template` below when filing your issues.
Issue in Librem 5 Application
-----------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
First, you will need to identify what type of application your issue is related to. There are two types of Librem 5 applications:
......@@ -32,7 +34,7 @@ First, you will need to identify what type of application your issue is related
2. Other applications
Base Applications
"""""""""""""""""
-----------------
Issues for **base applications** should be filed under the issues for that repository.
......@@ -42,14 +44,58 @@ An example of a **base application** would be:
For a list of these base applications, see `Apps_issues README <https://source.puri.sm/Librem5/Apps_Issues/blob/master/README.md>`_. You can also search `the existing GitLab repositories <https://source.puri.sm/Librem5/>`_.
Please follow the :ref:`problem-issue-template` below when filing your issues.
Other Applications
""""""""""""""""""
------------------
Issues for **other applications** will be tracked in `Apps_issues <https://source.puri.sm/Librem5/Apps_Issues/issues>`_. Your issue would go here if you have a concern with a phone application for which there is no *base application* corresponding repository.
Some examples of *other application* issues would be:
* You wish there were X application available for the phone and want to file an issue about it in hopes someone creates it.
* You have an issue with X application that has been added for the phone and there is not a specific GitLab repository for said *base application*
* You have an issue with X application that has been added for the phone and there is not a specific GitLab repository for said *base application*. Please follow the :ref:`problem-issue-template` below when filing your issues.
* You wish there were X application available for the phone and want to file an issue about it in hopes someone creates it. Please follow the :ref:`wishlist-issue-template` below 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.
Issue Templates
---------------
.. _problem-issue-template:
Problem Issue Template
""""""""""""""""""""""
Here is a template you can use to help to make sure the key information is captured on a problem encountered::
# What problem did you encounter
## What is the current behaviour?
## What is the expected behaviour?
## How to reproduce
Please provide steps to reproduce the issue. If it's a graphical issue please attach screenshot.
# Which version did you encounter the bug in?
- [ ] I Compiled it myself. If you compiled the application from source please provide the git revision via e.g. by running ``git log -1 --pretty=oneline`` and pasting the output below.
- [ ] I used the precompiled Debian package (e.g. by running a prebuilt image). Please paste the output of ``dpkg -s <app name>`` below.
.. _wishlist-issue-template:
Wishlist Issue Template
"""""""""""""""""""""""
Here is a template you can use when you'd like to file a wishlist item issue (i.e. you would like to see X application added/ported to the phone)::
# What application do you want added/ported and what is its function?
# Why is this application better than other applications that serve the same function (like Notes vs Tomboy)?
# If you have any insight into how difficult the work involved is, please specify.
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