Skip to content
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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pllim
Copy link
Collaborator

@pllim pllim commented Dec 29, 2020

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

@pllim pllim added enhancement maintenance Work done to keep code maintained labels Dec 29, 2020
@pllim pllim added this to the 3.2 milestone Dec 29, 2020
@pllim pllim requested a review from ejeschke December 29, 2020 22:34
@ejeschke
Copy link
Owner

ejeschke commented Jan 4, 2021

Is there a way to try it out from the PR?

@pllim
Copy link
Collaborator Author

pllim commented Jan 5, 2021

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.

Copy link
Owner

@ejeschke ejeschke left a 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.

@pllim
Copy link
Collaborator Author

pllim commented Jan 6, 2021

Indeed, not everyone reads the template, but from the experience over at astropy, you might have maybe 50% success rate. 😉

@pllim
Copy link
Collaborator Author

pllim commented Jan 6, 2021

I'll let you merge if you choose to accept the template. 😄

@ejeschke ejeschke modified the milestones: 3.2, 3.3 May 27, 2021
@ejeschke ejeschke modified the milestones: 3.3, 3.4 Feb 18, 2022
@ejeschke ejeschke changed the base branch from master to main July 12, 2023 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement maintenance Work done to keep code maintained
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants