diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b9e6e3de..e35d2a0a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Create a report to help us improve +about: Create a report to help us improve the project! title: '' labels: bug assignees: '' @@ -11,6 +11,7 @@ assignees: '' A clear and concise description of what the bug is. **Expected Error / Traceback** + ``` Please provide the error traceback here ``` @@ -20,9 +21,22 @@ Please provide how you run the dashboard **OS Information:** - OS: [e.g. Ubuntu 18.02] - - Python Version: [e.g v3.7] + - Docker: [e.g. Yes or No] + - Python Version: [e.g v37] + +**Docker Details** +If using docker, provide the following: + - Image used: [e.g. ghcr.io/wgdashboard/wgdashboard:latest] + - Compose: [e.g. Yes or No] +If Docker Compose is used: + +```yaml +**Your Docker Compose** +``` **Sample of your `.conf` file** -``` -Please provide a sample of your configuration file that you are having problem with. You can replace your public key and private key to ABCD... + +```ini +Please provide a sample of your configuration file that you are having problem with. +You should replace your public key and private key to ABCD... ``` diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..1df4b30d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: WGDashboard Community Support (Github) + url: https://github.com/orgs/WGDashboard/discussions + about: Please ask and answer questions here. + + - name: WGDashboard Community Support (Discord) + url: https://discord.gg/72TwzjeuWm + about: Discord Server about WGDashboard + + - name: WGDashboard Issue reporting (Bugs and Feature Requests (FR)) + url: https://github.com/WGDashboard/WGDashboard/issues + about: Please report bugs or feature requests here so they can be tracked + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 6665601b..18508344 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,6 +1,6 @@ --- -name: Feature request -about: Suggest an idea for this project +name: Feature Request (FR) +about: Suggest an idea to extend or improve the usage of the project title: '' labels: enhancement assignees: '' @@ -10,5 +10,11 @@ assignees: '' **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**Related/Adjacent Issues** +Paste a Github link to possible issues that could be solved if they exist. + +**What have you done yourself?** +What have you already tried to do or considered to fix this issue? + **Describe the solution you'd like** A clear and concise description of what you want to happen.