From 9a91f752d898c10a7d6ef16f8fcc07ab130fe30c Mon Sep 17 00:00:00 2001 From: Horilla <131998600+horilla-opensource@users.noreply.github.com> Date: Wed, 23 Aug 2023 14:47:18 +0530 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 83 +++++++++++++++-------- .github/ISSUE_TEMPLATE/feature_request.md | 44 +++++++++--- 2 files changed, 90 insertions(+), 37 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea782..517f8e7d1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,32 +7,57 @@ assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. +# Bug Report + +## Description + +_[A brief description of the bug or issue you're encountering.]_ + +## Steps to Reproduce + +1. _[Detailed step-by-step instructions to reproduce the issue.]_ + +## Expected Behavior + +_[What you expected to happen.]_ + +## Actual Behavior + +_[What actually happened.]_ + +## Screenshots + +_[If applicable, provide screenshots illustrating the issue.]_ + +## Environment + +- **Django Version:** _[Django version you're using, e.g., 3.2.1]_ +- **Python Version:** _[Python version, e.g., 3.9]_ +- **Operating System:** _[Your OS, e.g., Windows 10, Ubuntu 20.04]_ +- **Browser:** _[If applicable, specify the browser and version you're using.]_ + +## Additional Information + +_[Any other relevant information, logs, error messages, or context that might help in understanding and fixing the issue.]_ + +## Possible Solution + +_[If you have any ideas or suggestions on how to fix the issue, feel free to provide them here. This is optional.]_ + +## Labels + +_[If your project uses labels, suggest any labels that might apply to this issue, such as 'bug', 'needs investigation', etc.]_ + +## Priority + +_[Specify the priority level for this issue, such as 'high', 'medium', 'low', etc.]_ + +## Assignees + +_[If you want to suggest an assignee or tag a specific person to look into this issue, mention their GitHub username here.]_ + +## Related Issues + +_[If there are any related issues or pull requests, mention them here. This is optional.]_ + +**Note:** _Remember to search through existing issues before submitting a new one to ensure that the issue hasn't been reported already. Provide as much information as possible to help the maintainers understand and address the problem effectively._ diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7d6..846b8a264 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,14 +7,42 @@ 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 [...] +# Feature Request -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +## Description -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +_[A brief description of the new feature you're requesting.]_ -**Additional context** -Add any other context or screenshots about the feature request here. +## Use Case + +_[Explain how this feature would be useful and how it fits into the project's context.]_ + +## Proposed Solution + +_[Provide your ideas or suggestions on how this feature could be implemented. This is optional.]_ + +## Benefits + +_[Highlight the benefits and value this feature would bring to users or the project as a whole.]_ + +## Additional Information + +_[Any other relevant information, details, or examples related to the feature request.]_ + +## Labels + +_[If your project uses labels, suggest any labels that might apply to this feature request, such as 'enhancement', 'feature request', etc.]_ + +## Priority + +_[Specify the priority level for this feature request, such as 'high', 'medium', 'low', etc.]_ + +## Assignees + +_[If you want to suggest an assignee or tag a specific person to consider this feature request, mention their GitHub username here.]_ + +## Related Issues + +_[If there are any related issues or pull requests, mention them here. This is optional.]_ + +**Note:** _Before submitting a new feature request, please search through existing issues to ensure that the feature hasn't been requested already. Provide clear and concise information to help the maintainers understand the proposed feature and its potential impact._