Update issue templates #96
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds standard GitHub issue templates to the repository to help users provide structured information when reporting bugs or requesting features. The templates follow common GitHub conventions and include appropriate sections for bug reports and feature requests.
Key Changes
- Added a feature request template with sections for problem description, desired solution, alternatives, and additional context
- Added a bug report template with detailed sections for reproduction steps, expected behavior, curl information, and screenshots
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
.github/ISSUE_TEMPLATE/feature_request.md |
Adds a standard feature request template with sections for problem description, desired solution, alternatives, and additional context |
.github/ISSUE_TEMPLATE/bug_report.md |
Adds a comprehensive bug report template with sections for reproduction steps, expected behavior, curl details, and screenshots |
|
|
||
| **Curl (please complete the following information):** | ||
| - Headers | ||
| - Body |
There was a problem hiding this comment.
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.
| - Body | |
| - Body |
| 2. Backend Details: '....' | ||
| 3. Request Curl: '....' | ||
| 4. Where do you see the error | ||
| 5. Attach any logs to illustrate the issue: |
There was a problem hiding this comment.
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.
| 5. Attach any logs to illustrate the issue: | |
| 5. Attach any logs to illustrate the issue: |
| 2. Backend Details: '....' | ||
| 3. Request Curl: '....' |
There was a problem hiding this comment.
[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.
| 2. Backend Details: '....' | |
| 3. Request Curl: '....' | |
| 2. Backend details: '....' | |
| 3. Request curl: '....' |
| 1. Server environment variables: '...' | ||
| 2. Backend Details: '....' | ||
| 3. Request Curl: '....' | ||
| 4. Where do you see the error | ||
| 5. Attach any logs to illustrate the issue: | ||
|
|
||
| **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 |
There was a problem hiding this comment.
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.
No description provided.