Skip to content

Commit

Permalink
Added GitHub issue templates.
Browse files Browse the repository at this point in the history
  • Loading branch information
jlesage committed May 9, 2023
1 parent 615f79c commit f7ef116
Show file tree
Hide file tree
Showing 3 changed files with 117 additions and 0 deletions.
93 changes: 93 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
name: Bug report
description: File a bug report.
title: "[Bug] Provide a short description of the bug here"
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
Provide details about the host running the container.
Examples:
- Operating system (e.g. Ubuntu, Windows, TrueNAS, openmediavault, unRAID, etc).
- Version of the operating system.
- CPU architecture (x86-64, arm, arm64, etc).
- Model of the device, if applicable (e.g. Raspberry Pi 4B, Synology DS418, QNAP TS-364, etc).
- The Docker version (output of `docker version`).
- Anything else specific to your environment. Examples:
- Network share (NFS, CIFS) mapped to the container.
- Docker running in LXC container.
- etc.
- If applicable, how the UI provided by the container is access:
- Browser (Chrome, Firefox, Edge, etc).
- Version of the browser.
- OS of the browser.
- Is the container accessed through a reverse proxy.
- etc.
value: |
- OS:
- OS version:
- CPU:
- Docker version:
- Device model:
- Browser/OS:
validations:
required: false
- type: textarea
attributes:
label: Container creation
description: |
How did you create the container ?
Examples:
- The `docker run` command used.
- The compose file used.
- Screenshots of the management tool UI (e.g. Portainer, unRAID, etc) showing container settings.
validations:
required: true
- type: textarea
attributes:
label: Container log
description: Please copy/paste the output of `docker logs <container name>`.
render: text
validations:
required: true
- type: textarea
attributes:
label: Container inspect
description: |
If the container is running, please provide the output of `docker inspect <container name>`.
**Attention**: If you defined passwords, secrets or any sensitive information via environment variables, make sure to remove them from the output.
render: text
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Anything that will give more context about the issue you are encountering.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Ask a question, discuss
url: https://github.com/jlesage/docker-jdownloader-2/discussions
about: Get help using this Docker container.
- name: Documentation
url: https://github.com/jlesage/docker-jdownloader-2#readme
about: Documentation about this Docker container.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Feature request
description: Suggest an idea for this project.
title: "[Feature request] Provide a short description of the feature here"
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thank you for suggesting an idea to make this project better.
- type: textarea
attributes:
label: Idea
description: |
Please describe the desired behavior, pitch your idea, or suggest improvements.
validations:
required: true

0 comments on commit f7ef116

Please sign in to comment.