diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..daa8c32c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,30 @@ +--- +name: Feature request +about: Suggest an idea for how to improve the OPNsense documentation +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/docs/blob/master/CONTRIBUTING.md +- [ ] I have searched the existing issues and I am convinced that mine is new. + +**Is your feature request related to a problem? Please describe.** + +A clear and concise description of what the problem is including your motivation for the request, +i.e. "For the purpose of [...] I am missing a solution that will [...]." + +**Describe the solution you like** + +A clear and concise description of what you want to happen. + +**Describe alternatives you considered** + +A clear and concise description of any alternative solutions or features you considered. + +**Additional context** + +Add any other context or screenshots about the feature request here or links to relevant forum thread or similar diff --git a/.github/ISSUE_TEMPLATE/issue_report.md b/.github/ISSUE_TEMPLATE/issue_report.md new file mode 100644 index 00000000..3a1931e3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_report.md @@ -0,0 +1,36 @@ +--- +name: Issue report +about: Create a report to help us improve OPNsense's documentation +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/docs/blob/master/CONTRIBUTING.md +- [ ] I have searched the existing issues and I am convinced that mine is new. + +**Describe the issue** + +A clear and concise description of what the issue is, where in the documentation did you find it. +(e.g. on https://docs.opnsense.org/intro.html I've missed some context around ... ) + +**Suggestions** + +Provide suggestions in howto improve the paragraph or chapter in question. +(e.g. could be a simple typo or an explanation how a (part of) the text can be improved) + +**Version affected** + +Which version of the software are you using? +(e.g. OPNsense 21.1) + +**Describe alternatives you considered** + +A clear and concise description of any alternative solutions or workaround you considered. + +**Additional context** + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..11bbcf56 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,15 @@ +--- +name: Question +about: Ask a question about the OPNsense documentation, but before you do, please consider using our forum +title: '' +labels: support +assignees: '' +--- +**Important notices** + +Our forum is located at https://forum.opnsense.org , please consider joining discussions there in stead of using GitHub for these matters. + +Before you ask a new question, we ask you kindly to acknowledge the following: + +- [ ] I have read the contributing guide lines at https://github.com/opnsense/docs/blob/master/CONTRIBUTING.md +- [ ] I have searched the existing issues and I am convinced that mine is new.