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.

Sign up for GitHub

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

Jump to bottom

tools: capitalize sentences #24808

Closed
wants to merge 1 commit into from
Closed

tools: capitalize sentences #24808

wants to merge 1 commit into from

Conversation

BridgeAR
Copy link
Member

@BridgeAR BridgeAR commented Dec 3, 2018

This adds the capitalized-comments eslint rule to verify that
actual sentences use capital letters as starting letters. It ignores
special words and all lines below 62 characters. That way it will
mainly detect sentences. This way the code changes are kept low.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot
Copy link
Collaborator

@BridgeAR build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/1805/pipeline

@nodejs-github-bot nodejs-github-bot added the lib / src Issues and PRs related to general changes in the lib or src directory. label Dec 3, 2018
@BridgeAR
Copy link
Member Author

BridgeAR commented Dec 3, 2018

As a note: this rule is able to autofix.

@BridgeAR
Copy link
Member Author

BridgeAR commented Dec 5, 2018

This needs some reviews.

@nodejs/documentation PTAL (it is somewhat loosely related to docs).

@BridgeAR
Copy link
Member Author

BridgeAR commented Dec 6, 2018

@nodejs/linting PTAL

@BridgeAR
Copy link
Member Author

BridgeAR commented Dec 6, 2018

CI https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/1855/

rubys
rubys reviewed Dec 6, 2018
View reviewed changes
doc/api/dns.md Outdated Show resolved Hide resolved
@BridgeAR
Copy link
Member Author

BridgeAR commented Dec 8, 2018 •
edited by Trott
Loading

CI https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/1867/ ✔️

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 8, 2018
Trott
Trott reviewed Dec 8, 2018
View reviewed changes
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

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

Since a review was requested from me:

No objection. I'm not a fan of all the churn for something like this, but I'm also not a fan of watching nit after nit to newcomer contributors telling them to capitalize comments, so I'm good with it.

One nit on the commit message: I'd prefer if "comments" appeared somewhere in the first line of the commit message so that someone scanning commits doesn't think this is about other text.

@Trott
Copy link
Member

Trott commented Dec 8, 2018

Needs a rebase. (One test was moved from parallel to sequential.)

@Trott Trott removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 8, 2018
@ryzokuken
Copy link
Contributor

No objection. I'm not a fan of all the churn for something like this, but I'm also not a fan of watching nit after nit to newcomer contributors telling them to capitalize comments, so I'm good with it.

I see where you're coming from. That said, I think it's important that nits like these are handled by the tooling. Ideally, IMHO, there should be no nits on the actual PR. The linting setup should be powerful enough to take care of all possible nits and more. This PR helps in that respect, I feel.

ryzokuken
ryzokuken approved these changes Dec 8, 2018
View reviewed changes
Copy link
Contributor

@ryzokuken ryzokuken left a comment

Choose a reason for hiding this comment

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

Great catch.

@Trott
Copy link
Member

Trott commented Dec 8, 2018

That said, I think it's important that nits like these are handled by the tooling.

@ryzokuken Yeah, that's what I was trying to say. I'm not a fan of Collaborators leaving nits about this sort of thing all the time. I'd prefer the tooling do it. So, despite the churn, I"m OK with this.

@BridgeAR
tools: capitalize sentences
26d88c8 
This adds the `capitalized-comments` eslint rule to verify that
actual sentences use capital letters as starting letters. It ignores
special words and all lines below 62 characters.
@BridgeAR
Copy link
Member Author

Rebased

CI https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/1883/

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 10, 2018
BridgeAR added a commit to BridgeAR/node that referenced this pull request Dec 10, 2018
@BridgeAR
tools: capitalize sentences
1f85ea9 
This adds the `capitalized-comments` eslint rule to verify that
actual sentences use capital letters as starting letters. It ignores
special words and all lines below 62 characters.

PR-URL: nodejs#24808
Reviewed-By: Sam Ruby <rubys@intertwingly.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@BridgeAR
Copy link
Member Author

Landed in 1f85ea9

@BridgeAR BridgeAR closed this Dec 10, 2018
BethGriggs pushed a commit that referenced this pull request Dec 17, 2018
@BridgeAR @BethGriggs
tools: capitalize sentences
e140d41 
This adds the `capitalized-comments` eslint rule to verify that
actual sentences use capital letters as starting letters. It ignores
special words and all lines below 62 characters.

PR-URL: #24808
Reviewed-By: Sam Ruby <rubys@intertwingly.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@BethGriggs BethGriggs mentioned this pull request Dec 18, 2018
Merged
@beevelop beevelop mentioned this pull request Dec 18, 2018
Closed
refack pushed a commit to refack/node that referenced this pull request Jan 14, 2019
@BridgeAR @refack
tools: capitalize sentences
f0aac1f 
This adds the `capitalized-comments` eslint rule to verify that
actual sentences use capital letters as starting letters. It ignores
special words and all lines below 62 characters.

PR-URL: nodejs#24808
Reviewed-By: Sam Ruby <rubys@intertwingly.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@BridgeAR BridgeAR deleted the capitalize-letters branch January 20, 2020 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Trott Trott Trott left review comments

@vsemozhetbyt vsemozhetbyt vsemozhetbyt left review comments

@rubys rubys rubys approved these changes

@thefourtheye thefourtheye thefourtheye approved these changes

@ryzokuken ryzokuken ryzokuken approved these changes

@trivikr trivikr trivikr approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. lib / src Issues and PRs related to general changes in the lib or src directory.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@BridgeAR @nodejs-github-bot @Trott @ryzokuken @rubys @thefourtheye @vsemozhetbyt @trivikr @BethGriggs