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

Update PULL_REQUEST_TEMPLATE.md #12848

Merged
merged 1 commit into from Feb 1, 2020
Merged

Conversation

balazsorban44
Copy link
Contributor

@balazsorban44 balazsorban44 commented Jan 30, 2020

Fixing a typo.

Prerequisites checklist

  • I have read the contributing guidelines.
  • The team has reached consensus on the changes proposed in this pull request. If not, I understand that the evaluation process will begin with this pull request and won't be merged until the team has reached consensus.

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.

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Jan 30, 2020
@platinumazure
Copy link
Member

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!

@platinumazure platinumazure added chore This change is not user-facing and removed triage An ESLint team member will look at this issue soon labels Jan 30, 2020
Copy link
Member

@platinumazure platinumazure left a 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!

@kaicataldo
Copy link
Member

If you wouldn't mind updating the commit message to start with Chore:, that would be great.

@balazsorban44
Copy link
Contributor Author

Thanks for all the comments! 🙂 Fixed now, and I understand the reasoning.

Copy link
Member

@kaicataldo kaicataldo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you!

@kaicataldo kaicataldo merged commit 9f39ef0 into eslint:master Feb 1, 2020
@kaicataldo
Copy link
Member

Thanks for contributing to ESLint!

montmanu pushed a commit to montmanu/eslint that referenced this pull request Mar 4, 2020
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Aug 1, 2020
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Aug 1, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion chore This change is not user-facing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants