From 5aae711bc68636f1a53949c012cad90e78fb50fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Sat, 26 Sep 2015 15:41:42 +0000 Subject: [PATCH] Add label explanation to the CONTRIBUTING file --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 17928fb1..887f1347 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,3 +2,25 @@ Welcome to the Shout community, it's great to have you here! We thank you in advance for your contributions. + +### Labels + +When you open an [issue](https://github.com/erming/shout/issues) or send us a +[PR](https://github.com/erming/shout/pulls), it will most likely be given one or +several labels. Here is what they mean: + +- **bug**: Issues that report and PRs that solve any defects that cause + unexpected behaviors. +- **documentation**: Tickets that mention a lack of documentation, suggest their + improvement, or PRs that address these. +- **duplicate**: Tickets already solved in the past or already open. Such + tickets should always link to the previous one on the subject. +- **enhancement**: Tickets that describe a desired feature or PRs that add them + to the project. +- **help wanted**: Tickets that we would like the community to help us with, by + either answering questions or send us PRs. +- **priority**: Tickets that the core team deemed critical and PRs that the core + team should look at before others. +- **question**: Tickets that are actually support cases. +- **wontfix**: Tickets that, after discussion and explanation, will not be fixed + or implemented.