Skip to content

Update issue templates #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ian-t-adams merged 1 commit into from
Jan 20, 2026
Merged

Update issue templates #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Server environment variables: '...'
2. Backend Details: '....'
3. Request Curl: '....'
Comment on lines +16 to +17
Copy link

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Inconsistent capitalization in list items. Line 16 uses "Backend Details" with capital D, while line 17 uses "Request Curl" with capital C and capital R. For consistency, consider using lowercase for items in the numbered list (e.g., "backend details", "request curl") or capitalize all items consistently.

Suggested change
2. Backend Details: '....'
3. Request Curl: '....'
2. Backend details: '....'
3. Request curl: '....'

Copilot uses AI. Check for mistakes.
4. Where do you see the error
5. Attach any logs to illustrate the issue:
Copy link

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Trailing colon has extra space. The line ends with : (colon followed by a space), which is inconsistent with other similar lines in the template. Consider removing the trailing space after the colon.

Suggested change
5. Attach any logs to illustrate the issue:
5. Attach any logs to illustrate the issue:

Copilot uses AI. Check for mistakes.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add logs and screenshots to help explain your problem.

**Curl (please complete the following information):**
- Headers
- Body
Copy link

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent list formatting: Line 28 uses a space before the dash ( - Headers) while line 29 doesn't (- Body). Both should use the same formatting for consistency, preferably - Body to match line 28.

Suggested change
- Body
- Body

Copilot uses AI. Check for mistakes.
Comment on lines +15 to +29
Copy link

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The bug report template here explicitly asks for Server environment variables, full request Curl details including Headers and Body, and attached logs, which can easily include secrets such as API keys, tokens, passwords, or internal hostnames. An attacker monitoring public issues could harvest these values if reporters follow this guidance. Tighten these prompts to request only minimal, sanitized data (for example, specific non-secret env vars or redacted request samples) and add explicit instructions not to include secrets, access tokens, or passwords in issues.

Copilot uses AI. Check for mistakes.


**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
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.