2015-09-26 15:41:16 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Welcome to the Shout community, it's great to have you here! We thank you in
|
|
|
|
|
advance for your contributions.
|
2015-09-26 15:41:42 +00:00
|
|
|
|
|
|
|
|
### 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.
|
2015-10-06 04:20:59 +00:00
|
|
|
- **quick and easy**: Tickets that should be fairly simple to implement, even
|
|
|
|
|
for developers not yet involved in the project.
|
|
|
|
|
- **security**: Tickets that describe a security concern or PRs that must be
|
|
|
|
|
reviewed with extra care regarding security.
|
2015-09-26 15:41:42 +00:00
|
|
|
- **wontfix**: Tickets that, after discussion and explanation, will not be fixed
|
|
|
|
|
or implemented.
|
