This pull request adds a new feature to the repository: a template for bug reports and feature requests.
Why we need the feature
Having standardized templates for bug reports and feature requests helps streamline the process of reporting issues and requesting new features. It ensures that all necessary information is provided, making it easier for maintainers to understand and address the issues or requests.
How to implement and why
Create Bug Report Template:
File: .github/ISSUE_TEMPLATE/bug_report.yml
This template will guide users to provide detailed information about the bug, including steps to reproduce, expected behavior, and actual behavior.
Create Feature Request Template:
File: .github/ISSUE_TEMPLATE/feature_request.yml
This template will guide users to provide detailed information about the feature they are requesting, including the purpose, benefits, and any relevant details.
Update README:
File: README.md
Add a section in the README to inform contributors about the new templates and how to use them.
Test the Templates:
Ensure that the templates are correctly formatted and appear as expected when creating new issues in the repository.
By implementing these steps, we can improve the efficiency and effectiveness of issue tracking and feature requests in the repository.
Original issue: #32
What is the feature
This pull request adds a new feature to the repository: a template for bug reports and feature requests.
Why we need the feature
Having standardized templates for bug reports and feature requests helps streamline the process of reporting issues and requesting new features. It ensures that all necessary information is provided, making it easier for maintainers to understand and address the issues or requests.
How to implement and why
Create Bug Report Template:
.github/ISSUE_TEMPLATE/bug_report.yml
Create Feature Request Template:
.github/ISSUE_TEMPLATE/feature_request.yml
Update README:
README.md
Test the Templates:
By implementing these steps, we can improve the efficiency and effectiveness of issue tracking and feature requests in the repository.
Test these changes locally