Skip to content
This repository was archived by the owner on Sep 7, 2020. It is now read-only.

Hotfix/change commit message length related guidelines #1581

Open
morantr wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Hotfix/change commit message length related guidelines #1581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b86e29
CONTRIBUTING.md: Change commit message related guidelines
morantr Aug 5, 2020
63dd0af
VSCODE: Add the new commit message length gudlienes as VSCODE settings
morantr Aug 5, 2020
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
3 changes: 3 additions & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@
"files.insertFinalNewline": true,
"files.trimFinalNewlines": true,
"editor.formatOnSave": true,
"git.inputValidation": "always",
"git.inputValidationSubjectLength": 72,
"git.inputValidationLength": 100,
"C_Cpp.default.defines": [
"BEEROCKS_LINUX",
"BEEROCKS_CONF_PATH=\"build/install/config\"",
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ The subject must be very short, it appears in the [short log](https://github.com
If you feel multiple components apply, you should try to split up the commit into separate commits.
The component does not always correspond to a directory.
E.g. a change to [this file](CONTRIBUTING.md) would have `documentation` as component, even if it's not in the `documentation` directory.
* If the change is to a specific class or function, add it after the component
* In principle maximum 62 characters (including prefix).
* If the change is to a specific class or function, add it after the component.
* In principle maximum 72 characters (including prefix), because GitHub wraps the subject line at this limit.
Because prefixes can be long (e.g. `transport: Ieee1905Transport::update_network_interfaces():`, this limit is often exceeded.
* Describes the "what" succinctly.
* Avoid verbs that don't say anything: "fix", "improve", "update", ...
Expand Down Expand Up @@ -172,7 +172,7 @@ Followed by the commit that actually makes the change:
The extended description only needs to be added if there is actually something to say.
For example, the commit that added this document only had the subject line "documentation: add CONTRIBUTING.md" and no extended description.

The extended description should be wrapped at 72 columns (because `git log` indents with a tab, so it still fits on an 80-character line).
The extended description should be wrapped at 100 columns (same limitation we have on code lines, to allow comfortable reading).
There are four exceptions:

* Strings found in log files should be copied as is, to simplify searching through the history.
Expand Down