2
0
mirror of https://github.com/opnsense/docs synced 2024-11-09 01:10:33 +00:00
opensense-docs/.github/ISSUE_TEMPLATE/issue_report.md
2021-01-28 13:12:17 +01:00

37 lines
1.1 KiB
Markdown

---
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.