Skip to content

Best Practices for Creating a GitHub Issue

Mai edited this page Feb 25, 2025 · 1 revision

GitHub Issues are used to track tasks, enhancements, and bugs in the project. Each issue should be well-documented with a clear title and description. Use the following template when creating a new issue to ensure clarity and completeness:

## Issue Title
Provide a short and descriptive title

### Description
Explain the issue in detail, including what the problem is, why it matters, and any context necessary.

### Steps to Reproduce (if applicable, usually for a bug)
1. Step 1
2. Step 2
3. Step 3

### Expected Behavior
Describe what should happen.

### Actual Behavior (if applicable, usually for a bug)
Describe what actually happens.

### Suggested Fix (if applicable, usually for a bug)
Provide a possible solution or approach to resolving the issue.

### Screenshots (if applicable)
Attach any relevant screenshots or recordings.

### Acceptance Criteria
- [ ] Criterion 1
- [ ] Criterion 2
- [ ] Criterion 3

### Additional Context
Include any other relevant information, such as logs, environment details, or related issues.

### Labels
Apply appropriate labels, such as `bug`, `enhancement`, `documentation`, etc.

Creating a GitHub Issue

  • Navigate to the repository on GitHub.
  • Click on the "Issues" tab.
  • Click "New Issue".
  • Use the template above to fill in the issue details.
  • Add labels, milestones, or assignees if necessary.
  • Click "Submit new issue".
Clone this wiki locally