Skip to content

Commit 6518c9b

Browse files
committed
add issue templates
1 parent 5a3549d commit 6518c9b

File tree

3 files changed

+81
-0
lines changed

3 files changed

+81
-0
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for how to improve the OPNsense documentation
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
**Important notices**
9+
10+
Before you add a new report, we ask you kindly to acknowledge the following:
11+
12+
- [ ] I have read the contributing guide lines at https://github.com/opnsense/docs/blob/master/CONTRIBUTING.md
13+
- [ ] I have searched the existing issues and I am convinced that mine is new.
14+
15+
**Is your feature request related to a problem? Please describe.**
16+
17+
A clear and concise description of what the problem is including your motivation for the request,
18+
i.e. "For the purpose of [...] I am missing a solution that will [...]."
19+
20+
**Describe the solution you like**
21+
22+
A clear and concise description of what you want to happen.
23+
24+
**Describe alternatives you considered**
25+
26+
A clear and concise description of any alternative solutions or features you considered.
27+
28+
**Additional context**
29+
30+
Add any other context or screenshots about the feature request here or links to relevant forum thread or similar
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Issue report
3+
about: Create a report to help us improve OPNsense's documentation
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
**Important notices**
9+
10+
Before you add a new report, we ask you kindly to acknowledge the following:
11+
12+
- [ ] I have read the contributing guide lines at https://github.com/opnsense/docs/blob/master/CONTRIBUTING.md
13+
- [ ] I have searched the existing issues and I am convinced that mine is new.
14+
15+
**Describe the issue**
16+
17+
A clear and concise description of what the issue is, where in the documentation did you find it.
18+
(e.g. on https://docs.opnsense.org/intro.html I've missed some context around ... )
19+
20+
**Suggestions**
21+
22+
Provide suggestions in howto improve the paragraph or chapter in question.
23+
(e.g. could be a simple typo or an explanation how a (part of) the text can be improved)
24+
25+
**Version affected**
26+
27+
Which version of the software are you using?
28+
(e.g. OPNsense 21.1)
29+
30+
**Describe alternatives you considered**
31+
32+
A clear and concise description of any alternative solutions or workaround you considered.
33+
34+
**Additional context**
35+
36+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Question
3+
about: Ask a question about the OPNsense documentation, but before you do, please consider using our forum
4+
title: ''
5+
labels: support
6+
assignees: ''
7+
---
8+
**Important notices**
9+
10+
Our forum is located at https://forum.opnsense.org , please consider joining discussions there in stead of using GitHub for these matters.
11+
12+
Before you ask a new question, we ask you kindly to acknowledge the following:
13+
14+
- [ ] I have read the contributing guide lines at https://github.com/opnsense/docs/blob/master/CONTRIBUTING.md
15+
- [ ] I have searched the existing issues and I am convinced that mine is new.

0 commit comments

Comments
 (0)