From 24cce62669cec120624b68311d6b20a565f06331 Mon Sep 17 00:00:00 2001 From: Pulse Monitor Date: Thu, 11 Sep 2025 13:51:11 +0000 Subject: [PATCH] docs: add GitHub issue templates with diagnostics export instructions - add bug report template with instructions for attaching diagnostics - add feature request template - mention the 'Export for GitHub' option which provides sanitized diagnostics - helps users provide better information when reporting issues --- .github/ISSUE_TEMPLATE/bug_report.md | 41 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 28 ++++++++++++++++ 3 files changed, 77 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..a7944167e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,41 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 'bug' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Diagnostics Output** +Please attach the diagnostics output from Pulse: +1. Go to Settings tab +2. Scroll to the bottom +3. Click "Download Diagnostics" +4. Choose "Export for GitHub" (this creates a sanitized version without sensitive data) +5. Copy and paste the output here or attach as a file + +**Environment (please complete the following information):** + - Pulse Version: [e.g. v4.15.0] + - Installation Type: [e.g. ProxmoxVE LXC, Docker, Manual] + - Browser: [e.g. chrome, safari] + - Proxmox Version: [e.g. 8.2] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..b32ff04a4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Community Support + url: https://github.com/rcourtman/Pulse/discussions + about: Please ask and answer questions here + - name: Documentation + url: https://github.com/rcourtman/Pulse/wiki + about: Check the wiki for guides and documentation \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..ef85c9e81 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,28 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'enhancement' +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 [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. + +**Current Setup (optional)** +If relevant, you can attach diagnostics to show your current setup: +1. Go to Settings tab +2. Scroll to the bottom +3. Click "Download Diagnostics" +4. Choose "Export for GitHub" (sanitized version) +5. Attach if it helps explain your feature request \ No newline at end of file