First draft labelling system

erciccione 2021-03-19 10:07:29 +01:00
parent 3910468ba7
commit 741a4af13d

52
Labelling-system.md Normal file

@ -0,0 +1,52 @@
## Labelling system
We use a labelling system to keep things organized and to make easy for potential contributors to jump in. These [labels](https://github.com/haveno-dex/haveno/labels) are purposely generic, so to be helpful, but not restricting or too time consuming.
We have 4 main categories of labels. Every issue should have at least the label specifying the issue type (`is:`), but would be also good to include the 'about' label, to specify what section of Haveno the issue is about (`a:`). The priority label (`Pn`) is not strictly necessary, but it's helpful to make clear how urgent is the issue/request.
### What the issue is about (`a:`)
The part of Haveno the issue is about. Will help people to filter only the issues related to the area they are interested to.
Some examples:
- **a:documentation**
- **a:monero**
- **a:network**
- **a:trade process**
- **a:UI**
- **a:18n**
### Issue type (`is:`)
The type of issue/request.
some examples:
- **is:bug**
- **is:enhancement**
- **is:question**
- **is:refactor**
### Priority (`Pn`)
A simple priority process. Issues with higher priority should be worked first.
- **P1** - The issue is prioritary and should be solved ASAP
- **P2** - The issue is prioritary, but P1 issues should be resolved first, if possible
- **P3** - The issue should be worked on, but it's not prioritary
### Action needed (`needs:`)
These labels will be used as needed, for both issues and pull requests. They usually imply that the issue is blocked until a problem is solved or some info are provided.
some examples:
- **needs:discussion**
- **needs:investigation**
- **needs:more info**
- **needs:review**
### Mixed
We might use other labels when needed. As said at the beginning, this structure aims to be simple and not too strict.