CONTRIBUTING: small updates and label explanations

This commit is contained in:
Franco Fichtner 2019-06-13 16:59:11 +02:00
parent b0eeccb784
commit 3aa89a9bc2
1 changed files with 23 additions and 4 deletions

View File

@ -8,9 +8,9 @@ Issue reports
-------------
Issue reports can be bug reports or feature requests. Make sure to
search the issues before adding a new one. It is often better to
join ongoing discussions on similar issues than creating a new one
as there may be workarounds or ideas available.
search the open and closed issues before adding a new one. It is
often better to join an ongoing discussions on similar open issues
than creating a new one as there may be workarounds or ideas available.
When creating bug reports, please make sure you provide the following:
@ -19,10 +19,22 @@ When creating bug reports, please make sure you provide the following:
* The exact URL of the GUI page involved (if any)
* A list of steps to replicate the bug
Issue templates can help with getting this just right.
All issues reported will have to be triaged and prioritised. As we
are a small team we may not always have the time to implement and help,
but reporting an issue may help others to fill in.
The issue catetories are as follows:
* support: community-based help figuring out setup issues or code problems
* cleanup: cosmetic changes or non-operational bugs (display issues, etc.)
* bug: identified operational bug (core features, etc.)
* feature: behavioural changes, additions as well as missing options
* help wanted: a contributor is missing to carry out the work
* upstream: problem exists in the included third-party software
* incomplete: issue template missing or incomplete
Feature requests that are in line with project goals will eventually
be added to our roadmap:
@ -33,7 +45,14 @@ using the plugin framework:
https://github.com/opnsense/plugins/issues
Stale issues are timed out after several months of inactivity.
Stale issues are timed out after several months of inactivity. Please
note that this includes non-support issues such as feature requests
that are not picked up by a contributor, which means it is highly
unlikely the feature will be implemented in the first place unless a
pull request is provided along with the issue.
Responding to issues is completely voluntary for all participants.
As a general rule, closed tickets shall and will not be responded to.
And above all: stay kind and open. :)