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
Docs: Use GitHub Multiple PR/Issue templates #9911
Conversation
861d14f
to
e86c013
Compare
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.
💯
e86c013
to
e4058af
Compare
Question: Should we consolidate/move items in the templates folder into .github/ISSUE_TEMPLATE and update the website's issue guides to point directly there? I'm not sure if there's any reason to keep both directories but let me know if I'm missing something. |
The only issue with that is that we currently reference those templates in the PR template. Ideally, I'd like to do the same thing for PRs (linking to various PR templates) but I wasn't sure how to link to that URL, since it seems like it would be different for each PR. But maybe I'm wrong about that? If we can figure out how to do that, we can definitely remove the templates in the |
Not sure I understand this part? How would it be different for new PRs? |
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.
LGTM, thanks! (My question is definitely not meant to be a blocker)
Please correct me if I'm wrong, but I believe PR urls are unique per PR and look like: |
Good call, you're right-- if someone creates a pull request from a branch page or using the "recently pushed branches" div. However, there is a "New Pull Request" button on the PR list which links to (e.g.) https://github.com/eslint/eslint/compare, which could easily have a template on it. That page lets you pick the base and head branch; however, I admit it might not be an intuitive interface (and might not work for users' forks at all). So I think we would need to dig a bit more if we wanted to implement this for PRs as well. |
Personally, I almost never use the https://github.com/eslint/eslint/compare page to create a PR -- I look for the yellow bar on the front page of the repo that appears after I push a branch. |
How do we feel about merging this now and looking into using multiple PR templates in the future? Seems like merging this now would be an immediate win for anyone making a new issue :) |
What is the purpose of this pull request? (put an "X" next to item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[X] Other, please explain:
This change utilizes GitHub's new multiple issue and pull request templates feature to make it so that users don't have to copy and paste the the template questions manually when they're filing a new issue.
What changes did you make? (Give an overview)
Added more issues templates for the various types of issues we see reported.
Is there anything you'd like reviewers to focus on?
Thoughts on this change?
Also, I think this would be helpful for PRs as well, though I'm not sure how we would do that. Any ideas?
Wasn't entirely sure what labels to put on this, so please feel free to update if you deem it necessary!