-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Added issue templates for easier and more comprehensive issue g…
…eneration.
- Loading branch information
1 parent
fbab6f4
commit 90bbe60
Showing
3 changed files
with
128 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
name: "🐛 Bug report" | ||
about: "Report a bug to help us improve" | ||
title: "🐛 Title" | ||
labels: ["bug"] | ||
assignees: [''] | ||
--- | ||
### Issue Summary | ||
|
||
Briefly describe the issue you are experiencing. | ||
|
||
### Steps to Reproduce | ||
|
||
Provide a clear and concise set of steps to reproduce the issue. Include code snippets or screenshots if they can help in understanding the problem. | ||
|
||
1. Step 1 | ||
2. Step 2 | ||
3. ... | ||
|
||
### Expected Behavior | ||
|
||
Describe what you expected to happen. | ||
|
||
### Actual Behavior | ||
|
||
Describe what actually happened. | ||
|
||
### Environment | ||
|
||
- **Operating System:** | ||
- **Project Version/Commit:** | ||
- **Additional context (if any):** | ||
|
||
### Possible Solution | ||
|
||
(Optional) If you have suggestions on how to fix the issue or implement the feature, please let us know or open an improvement proposal. | ||
|
||
### Screenshots | ||
|
||
(Optional) If you can, add screenshots to help explain your problem. | ||
|
||
### Additional Information | ||
|
||
Add any other context or information about the issue here. | ||
|
||
#### Checklist | ||
- [] I have reviewed existing issues and confirmed that this issue has not been logged before. | ||
- [] I have provided minimal example of expected vs actual behavior. | ||
|
||
--- | ||
|
||
**Note:** Please make sure to check if there is already an existing issue similar to yours before submitting a new one. If you find an existing issue, | ||
you can comment on it to provide additional information or to show that you are experiencing the same problem. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: "✨ Feature request" | ||
about: "Suggest an idea for this project" | ||
title: "✨ Title" | ||
labels: ["feat request"] | ||
assignees: [''] | ||
--- | ||
|
||
### Is your feature request related to a problem? | ||
A clear and concise description of what the problem is. | ||
If an bug report exists please link it here. | ||
|
||
### Describe the behaviour you'd like | ||
A clear and concise description of what you want to happen. | ||
|
||
### Describe alternative software applications you've considered using | ||
A clear and concise description of any alternative software applications you've considered. | ||
|
||
### Describe workarounds you've implemented while the feature request is being reviewed | ||
If you can, add code snippets of any workaround you've implemented | ||
|
||
### Additional context | ||
Add any other context or screenshots about the feature request here. |
52 changes: 52 additions & 0 deletions
52
.github/workflows/ISSUE_TEMPLATE/improve_existing_functionality.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
name: "🛠 Improvement proposal" | ||
about: "Improve an existing feature" | ||
title: "🛠 Title" | ||
labels: ["enhancement"] | ||
assignees: [''] | ||
--- | ||
### Improvement Proposal | ||
|
||
Describe the improvement you would like to see. Be clear and concise. | ||
|
||
#### Current Functionality | ||
|
||
Describe the existing functionality or feature that you think needs improvement. | ||
|
||
#### Proposed Enhancement | ||
|
||
Detail your proposed enhancement or improvement. | ||
|
||
#### Motivation | ||
|
||
Explain why this improvement is necessary or beneficial. | ||
|
||
#### Expected Benefits | ||
|
||
Outline the benefits or outcomes you expect from implementing this improvement. | ||
|
||
#### Implementation Plan (Optional) | ||
|
||
If you have ideas or suggestions on how this improvement could be implemented, outline them here. | ||
|
||
#### Alternative Approaches or Workaround used before (Optional) | ||
|
||
If applicable, describe any alternative approaches you considered or explored. | ||
|
||
#### Screenshots or Additional Information | ||
|
||
If applicable. | ||
|
||
#### Checklist | ||
|
||
- [] I have reviewed existing issues and confirmed that this improvement has not been proposed before. | ||
- [] I have considered the impact of this improvement on other parts of the project. | ||
- [] I am willing to contribute to the implementation of this improvement if the proposal is accepted. | ||
|
||
#### Related Issues | ||
|
||
If your proposal is related to an existing issue or PR, mention it here. | ||
|
||
#### Additional Notes | ||
|
||
Add any additional notes or context about your proposal. |