Skip to content

Commit 2f15de1

Browse files
committed
Added GitHub issue templates.
1 parent fc5d9e1 commit 2f15de1

File tree

3 files changed

+117
-0
lines changed

3 files changed

+117
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name: Bug report
2+
description: File a bug report.
3+
title: "[Bug] Provide a short description of the bug here"
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: textarea
11+
attributes:
12+
label: Current Behavior
13+
description: A concise description of what you're experiencing.
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: Expected Behavior
19+
description: A concise description of what you expected to happen.
20+
validations:
21+
required: false
22+
- type: textarea
23+
attributes:
24+
label: Steps To Reproduce
25+
description: Steps to reproduce the behavior.
26+
validations:
27+
required: false
28+
- type: textarea
29+
attributes:
30+
label: Environment
31+
description: |
32+
Provide details about the host running the container.
33+
Examples:
34+
- Operating system (e.g. Ubuntu, Windows, TrueNAS, openmediavault, unRAID, etc).
35+
- Version of the operating system.
36+
- CPU architecture (x86-64, arm, arm64, etc).
37+
- Model of the device, if applicable (e.g. Raspberry Pi 4B, Synology DS418, QNAP TS-364, etc).
38+
- The Docker version (output of `docker version`).
39+
- Anything else specific to your environment. Examples:
40+
- Network share (NFS, CIFS) mapped to the container.
41+
- Docker running in LXC container.
42+
- etc.
43+
- If applicable, how the UI provided by the container is access:
44+
- Browser (Chrome, Firefox, Edge, etc).
45+
- Version of the browser.
46+
- OS of the browser.
47+
- Is the container accessed through a reverse proxy.
48+
- etc.
49+
value: |
50+
- OS:
51+
- OS version:
52+
- CPU:
53+
- Docker version:
54+
- Device model:
55+
- Browser/OS:
56+
validations:
57+
required: false
58+
- type: textarea
59+
attributes:
60+
label: Container creation
61+
description: |
62+
How did you create the container ?
63+
Examples:
64+
- The `docker run` command used.
65+
- The compose file used.
66+
- Screenshots of the management tool UI (e.g. Portainer, unRAID, etc) showing container settings.
67+
validations:
68+
required: true
69+
- type: textarea
70+
attributes:
71+
label: Container log
72+
description: Please copy/paste the output of `docker logs <container name>`.
73+
render: text
74+
validations:
75+
required: true
76+
- type: textarea
77+
attributes:
78+
label: Container inspect
79+
description: |
80+
If the container is running, please provide the output of `docker inspect <container name>`.
81+
**Attention**: If you defined passwords, secrets or any sensitive information via environment variables, make sure to remove them from the output.
82+
render: text
83+
validations:
84+
required: false
85+
- type: textarea
86+
attributes:
87+
label: Anything else?
88+
description: |
89+
Anything that will give more context about the issue you are encountering.
90+
91+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
92+
validations:
93+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Ask a question, discuss
4+
url: https://github.com/jlesage/docker-nginx-proxy-manager/discussions
5+
about: Get help using this Docker container.
6+
- name: Documentation
7+
url: https://github.com/jlesage/docker-nginx-proxy-manager#readme
8+
about: Documentation about this Docker container.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Feature request
2+
description: Suggest an idea for this project.
3+
title: "[Feature request] Provide a short description of the feature here"
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for suggesting an idea to make this project better.
10+
- type: textarea
11+
attributes:
12+
label: Idea
13+
description: |
14+
Please describe the desired behavior, pitch your idea, or suggest improvements.
15+
validations:
16+
required: true

0 commit comments

Comments
 (0)