-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added default issue template. #165
base: main
Are you sure you want to change the base?
Conversation
@microsoft-github-policy-service agree |
I think you should spend some time to modifying the issue templates to suit this repository rather than using the default |
Hello @l-lumin , Thanks for checking the pull request. Currently, I am not really sure what would be the best Issue template format for this project. Below are some of the issue templates that took a glance:-
Different repository have either markdown and form based issue template fine tuned to specific requirements for respective projects. Below are the points thatIi think they have in common which included in the issue template issue and pull request template.
Regards! |
I think for the issue templates, we should start with two types:
|
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove smartphone. combine with desktop
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for comment. I removed the smartphone information and removed extra space in between.
""" **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] """ And removed extra new lines between desktop and additional context.
Is there a reason you used md instead of YAML? https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository We should keep the issue template really concise. |
Hello @gagb , The reason is simplicity. YAML form based issue templates is also good. Since it is form based issue creator can add the specific information that they want in specific form based fields. It would also make sure that all the fields are filled with some information and no fields are empty. If we want concise information then we can go with YAML. Which one do you prefer? Thanks! |
No description provided.