Skip to content

Commit

Permalink
chore(templates): update issue templates with labels
Browse files Browse the repository at this point in the history
Added default labels for bug reports and feature requests to improve
issue categorization. Introduced a new template for stylistic issues
to enhance code consistency and readability. This helps streamline
issue triaging and encourages adherence to the project's style guide.
  • Loading branch information
YidiDev committed Oct 10, 2024
1 parent 03e72bb commit f830358
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
labels: 'bug'
assignees: ''

---
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
labels: 'enhancement'
assignees: ''

---
Expand Down
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/style.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
name: "Stylistic Issue"
about: Report an inconsistency or improvement related to code style or formatting.
title: "[STYLE] Brief description of the stylistic issue"
labels: 'style'
assignees: ''

---

## Description

<!-- Provide a clear and concise description of the stylistic issue you are facing.
Add context or background if necessary. -->

## Location

<!-- Identify where the stylistic issue is in the codebase.
Include file paths, line numbers, or relevant links if possible. -->

- File: `path/to/file`
- Line number(s): `line_number(s)`

## Expected Style

<!-- Describe the expected style or formatting according to the project's guidelines.
Link to the style guide or any relevant documentation if available. -->

## Current Style

<!-- Describe how the code currently appears and how it deviates from the expected style.
Providing a code snippet can be helpful. -->

## Additional Context

<!-- Add any other information or screenshots that could help with understanding the issue. -->

## Suggestions for Improvement

<!-- If you have ideas or suggestions for how to resolve the stylistic issue,
please share them here. Consider referencing examples or resources. -->

## Environment

<!-- If the issue is specific to a certain environment, please include details such as:
operating system, IDE/editor, language versions, etc. -->

## Checklist

- [ ] I have checked if this style is mentioned in the project's style guide.
- [ ] I have checked previous issues for similar stylistic concerns.

---

<!-- Note for contributors:
Thank you for helping us maintain and improve the project's consistency and readability.
Your input is valuable in making the codebase more accessible and maintainable. -->

0 comments on commit f830358

Please sign in to comment.