Issues - add contributing guidelines and issue template. As this is mostly upstream, don't include feature request templates or questions
This commit is contained in:
Ad Schellevis
Franco Fichtner
parent
c0be477c0f
commit
e10be74456
|
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve OPNsense
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
**Important notices**
|
||||
|
||||
Before you add a new report, we ask you kindly to acknowledge the following:
|
||||
|
||||
- [ ] I have read the contributing guide lines at https://github.com/opnsense/src/blob/master/CONTRIBUTING.md
|
||||
- [ ] I am convinced that my issue is new after having checked both open and closed issues at https://github.com/opnsense/src/issues?q=is%3Aissue
|
||||
|
||||
**Describe the bug**
|
||||
|
||||
A clear and concise description of what the bug is, including last known working version (if any).
|
||||
|
||||
*Tip*: to validate your setup was working with the previous version, use opnsense-revert (https://docs.opnsense.org/manual/opnsense_tools.html#opnsense-revert)
|
||||
|
||||
**To Reproduce**
|
||||
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Describe alternatives you considered**
|
||||
|
||||
A clear and concise description of any alternative solutions or workaround you considered.
|
||||
|
||||
**Screenshots**
|
||||
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Relevant log files**
|
||||
|
||||
If applicable, information from log files supporting your claim.
|
||||
|
||||
**Additional context**
|
||||
|
||||
Add any other context about the problem here.
|
||||
|
||||
**Environment**
|
||||
|
||||
Software version used and hardware type if relevant, e.g.:
|
||||
|
||||
OPNsense 19.1.1 (amd64, OpenSSL).
|
||||
Intel® Xeon™ E3-1225V5 3.3Ghz Quad Core
|
||||
Network Intel® I210-AT
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
Contributing to OPNsense
|
||||
========================
|
||||
|
||||
Thanks for considering a pull request or issue report. Below are a
|
||||
few hints and tips in order to make them as effective as possible.
|
||||
|
||||
Issue reports
|
||||
-------------
|
||||
|
||||
Issue reports can be bug reports or feature requests. Make sure to
|
||||
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:
|
||||
|
||||
* The current OPNsense version where the bug first appeared
|
||||
* The last OPNsense version where the bug did not exist
|
||||
* 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:
|
||||
|
||||
https://opnsense.org/about/road-map/
|
||||
|
||||
Feature requests beyond the scope of OPNsense may still be provided
|
||||
using the plugin framework:
|
||||
|
||||
https://github.com/opnsense/plugins/issues
|
||||
|
||||
Stale issues are timed out after 180 days 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. :)
|
||||
|
||||
Pull requests
|
||||
-------------
|
||||
|
||||
Since this is a "downstream" FreeBSD repository, most pull requests should
|
||||
be directed elsewhere unless specific for OPNsense.
|
||||
|
||||
When creating pull request, please heed the following:
|
||||
|
||||
* Base your code on the latest "primary" branch to avoid manual merges
|
||||
* Code review may ensue in order to help shape your proposal
|
||||
* Pull request must adhere to 2-Clause BSD licensing
|
||||
* Explain the problem and your proposed solution
|
||||
Loading…
Reference in New Issue