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
Update PULL_REQUEST_TEMPLATE.md #12848
Conversation
Hi @balazsorban44, thanks for the PR. Regarding the checkboxes not being checkboxes: This is intentional-- if you change them to checkboxes, then the PR List will show them as uncompleted tasks. (For example, this PR says only 3 out of 10 tasks are done.) In reality, only the first section is really supposed to be a task list. The second section is conceptually more like a radio button, but GitHub-flavored Markdown does not have any way to represent this. So we intentionally use text-based boxes and ask people to put an X in them, so it's clear what the pull request type is but also does not create new tasks that will never actually be completed. This is also referenced in prior discussions, including here. We would love to accept a PR for adding the word "an", as that is definitely a typo and we would love to fix it. So if you want to revert the check box changes but preserve the "an" addition, we could probably accept and merge this. Thanks! |
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.
Please revert the checkbox changes (rationale is explained in an earlier comment). Feel free to keep the change on the first line, though. Thanks for contributing!
If you wouldn't mind updating the commit message to start with |
756d8ec
to
73b95c9
Compare
Thanks for all the comments! 🙂 Fixed now, and I understand the reasoning. |
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, thank you!
Thanks for contributing to ESLint! |
Fixing a typo.
Prerequisites checklist
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: Fixing
PULL_REQUEST_TEMPLATE.md
What changes did you make? (Give an overview)
Corrected the markdown checklist, and added a word
Is there anything you'd like reviewers to focus on?
No.