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

doc: slightly relax 50 character rule #16523

Closed
wants to merge 3 commits into from

Conversation

jasnell
Copy link
Member

@jasnell jasnell commented Oct 26, 2017

Allow commit message first line to exceed 50 chars if necessary

ping @Trott ... btw, note that the contribution guide already uses "should* and not "must"

Checklist
Affected core subsystem(s)

doc

Allow commit message first line to exceed 50 chars if necessary
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Oct 26, 2017
@targos
Copy link
Member

targos commented Oct 26, 2017

+1: it's usually tricky to fit in 50 characters when the subsystem is child_process

@evanlucas
Copy link
Contributor

would we rather do this vs switch to something like 72 columns for the title? To me, the fewer exceptions we make, the easier it is to automate around it

@addaleax
Copy link
Member

@evanlucas I tried that back in #8327 but maybe people have changed their mind since :) I’d really like that.

@jasnell
Copy link
Member Author

jasnell commented Oct 26, 2017

I'd be happy with increasing to 72 characters but perhaps lets try this first and see how it goes?

Copy link
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

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

No strong opinion on this, but I would prefer to relax the 50 char limit instead of making 72 the new "hard limit", mainly because this is a Git convention (as far as I know). And I am pretty sure GitHub will cut long titles at a certain length, even though I don't know whether that's less than 72 chars.

@refack
Copy link
Contributor

refack commented Oct 26, 2017

/CC @nodejs/automation

@Fishrock123
Copy link
Contributor

Can we make sure we stick within the limit of what github will take without wrapping it into the description?

@addaleax
Copy link
Member

That’s 72, so: Yes, we’re going to do that anyway.

apapirovski referenced this pull request Oct 27, 2017
PR-URL: #16454
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
CONTRIBUTING.md Outdated
- be 50 characters or less
- be 50 characters or less (or as close as possible to 50 characters if it
is necessary to go over in order to provide a *useful* description of the
change)
Copy link
Member

Choose a reason for hiding this comment

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

Nit: how about remove this entire bullet point and change the first bullet point to this:

  • contain a short description of the change (preferably 50 characters or less)

@jasnell
Copy link
Member Author

jasnell commented Oct 27, 2017

All, please take a look, fairly significant change.

@lpinca
Copy link
Member

lpinca commented Oct 27, 2017

Still LGTM.

CONTRIBUTING.md Outdated
- contain a short description of the change
- be 50 characters or less
- contain a short description of the change (preferably 50 characters or less,
and absolutely no more than 72 characters)
Copy link
Member

Choose a reason for hiding this comment

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

Micro-nit, non-blocking obviously: remove absolutely

jasnell added a commit that referenced this pull request Oct 29, 2017
Allow commit message first line to exceed 50 chars if necessary

PR-URL: #16523
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
@jasnell
Copy link
Member Author

jasnell commented Oct 29, 2017

Landed in 1cdcab0

@jasnell jasnell closed this Oct 29, 2017
gibfahn pushed a commit that referenced this pull request Oct 30, 2017
Allow commit message first line to exceed 50 chars if necessary

PR-URL: #16523
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
gibfahn pushed a commit that referenced this pull request Oct 30, 2017
Allow commit message first line to exceed 50 chars if necessary

PR-URL: #16523
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
gibfahn pushed a commit that referenced this pull request Oct 31, 2017
Allow commit message first line to exceed 50 chars if necessary

PR-URL: #16523
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
@gibfahn gibfahn mentioned this pull request Oct 31, 2017
Qard pushed a commit to ayojs/ayo that referenced this pull request Nov 2, 2017
Allow commit message first line to exceed 50 chars if necessary

PR-URL: nodejs/node#16523
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Qard pushed a commit to ayojs/ayo that referenced this pull request Nov 2, 2017
Allow commit message first line to exceed 50 chars if necessary

PR-URL: nodejs/node#16523
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
MylesBorins pushed a commit that referenced this pull request Nov 16, 2017
Allow commit message first line to exceed 50 chars if necessary

PR-URL: #16523
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Nov 21, 2017
MylesBorins pushed a commit that referenced this pull request Nov 21, 2017
Allow commit message first line to exceed 50 chars if necessary

PR-URL: #16523
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
MylesBorins pushed a commit that referenced this pull request Nov 28, 2017
Allow commit message first line to exceed 50 chars if necessary

PR-URL: #16523
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
addaleax pushed a commit to ayojs/ayo that referenced this pull request Dec 7, 2017
Allow commit message first line to exceed 50 chars if necessary

PR-URL: nodejs/node#16523
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
@Announcement
Copy link

not important, and i know this is old news; just wondering, but why 72 instead of the standard 80?

@tniessen
Copy link
Member

@Announcement Let's see what Linus Torvalds, the inventor of Git, has to say about that:

[...] the rule is simple: we use 72-character columns for word-wrapping, except for quoted material that has a specific line format.

(And the rule is not 80 characters, because you do want to allow the standard indentation from git log, and you do want to leave some room for quoting).

Anyway, you are obviously free to do your commit messages any way you want. However, these are the rules we try to follow in the kernel, and in git itself.

And quite frankly, anybody who thinks they have better rules had better prove their point by showing a project with better commit messages. Quite frankly, I've seen a lot of open-source projects, and I have yet to see any project that does a better job of doing good commit messages than the kernel or git. And I've seen a lot of projects that do much worse.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.