Skip to content

doc: slightly relax 50 character rule #16523

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

Closed
wants to merge 3 commits into from
Closed

doc: slightly relax 50 character rule #16523

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d908eaf
doc: slightly relax 50 character rule
jasnell Oct 26, 2017
0da8671
[Squash] Reword
jasnell Oct 27, 2017
3664d77
[Squash] absolutely
jasnell Oct 27, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,9 @@ A good commit message should describe what changed and why.

1. The first line should:
- contain a short description of the change
- 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)

- be entirely in lowercase with the exception of proper nouns, acronyms, and
the words that refer to code, like function/variable names
- be prefixed with the name of the changed subsystem and start with an
Expand Down