-
Notifications
You must be signed in to change notification settings - Fork 77
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
MNT: Add issue and PR templates #917
base: main
Are you sure you want to change the base?
Conversation
Is there a way to try it out from the PR? |
Unfortunately, I don't think so. But I have deployed similar templates elsewhere. So you can look at https://github.com/spacetelescope/synphot_refactor/issues/new/choose for examples of how the issue templates would work. As for PR template, you won't see it in action until you open a PR against that repo, but it basically pre-fill the body of the PR, so instead of blank, you get those words you see on the template. |
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.
@pllim, this looks reasonable to me. I think my only concern is that for some users this may set enough "friction" that they don't follow through with an issue ("ah, there's all these fields! I won't bother").
But then again perhaps this will make it easier for them by the prompts. In any case, we can adjust it later as needed.
Indeed, not everyone reads the template, but from the experience over at |
I'll let you merge if you choose to accept the template. 😄 |
This pull request adds templates for new issues and pull requests. For issues, they are separated into feature request, bug report, and question categories. Also see https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests