Closed AnonymousCodes911 closed 2 months ago
@AnonymousCodes911 would you like to explain what these templates do, how they work, etc?
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 96.43%. Comparing base (
14756d9
) to head (45456e3
).:exclamation: Current head 45456e3 differs from pull request most recent head ffe2484. Consider uploading reports for the commit ffe2484 to get more accurate results
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Sure!, I thought it would be valuable to have a standardized process of creating issues on GitHub for different purposes related to Stingray. Therefore I added 3 templates to cover most of the Issues that are generated here on Stingray;
General Issue: For miscellaneous issues.
Report a Bug: For Stingray bugs.
Improving Documentation: For documentation suggestions.
Each template will facilitate users in providing detailed information about their issues, making it easier to collaborate on solutions.
Ok, but how do they work? Are they automatically picked up by Github? Where can I find details on the syntax, and test the templates? Is there a specific documentation for it?
Ok, but how do they work? Are they automatically picked up by Github?
Yes, ISSUE_TEMPLATES and PULL_REQUEST_TEMPLATE files are automatically recognized by GitHub. When they are a part of the .github
folder of the repository, GitHub will display these templates as options when users create a new issue or pull request.
Where can I find details on the syntax, and test the templates? Is there a specific documentation for it?
You can refer to the following documentation pages: Creating issue templates Creating pull request templates
To test the templates
You can test the templates by creating new issues or pull requests in the repository. After doing so, you will be prompted with various templates, and you can choose them according to your requirements.
fixes: #810 Added templates for : -BUG issues -Documentation Issues -Generic Issues