I'd like to put a basic guidelines for commit messages up for a vote.
The basic rules should read:
The intent of this guide is to reduce friction when working with code written by different authors. It does so by enumerating a shared set of rules and expectations about how to write good commit messages to enhance the ability to understand what, how and why people did something.
The guidelines rules herein are derived from many other guidelines for commit messages. When various authors collaborate across multiple projects, it helps to have one set of guidelines to be used among all those projects. Thus, the benefit of this guide is not in the rules themselves, but in the sharing of those rules.
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
1. The seven rules of a great Git commit message (the reference is in each rule)
- Subject SHOULD be separated from body with a blank line
- Subject line SHOULD be limited by 50 characters
- Subject line SHOULD be capitalized
- Subject line SHOULD NOT end with period
- Subject line SHOULD be using the english imperative mood
- Body SHOULD be wrapped at 72 characters
- Body SHOULD be used to explain what and why vs. how
2. Commit messages language
Commit messages MUST be in english.
Voting should be 👍, 👎 or self-declared abstentions.
Voting will close when all 7 voting members have cast their votes, or at February 9th 2017, at 15:45 BRST. If no minimum quorum (5 members) is met by then, the vote will fail and will have to be restarted.
I'd like to put a basic guidelines for commit messages up for a vote.
The basic rules should read:
The intent of this guide is to reduce friction when working with code written by different authors. It does so by enumerating a shared set of rules and expectations about how to write good commit messages to enhance the ability to understand what, how and why people did something.
The guidelines rules herein are derived from many other guidelines for commit messages. When various authors collaborate across multiple projects, it helps to have one set of guidelines to be used among all those projects. Thus, the benefit of this guide is not in the rules themselves, but in the sharing of those rules.
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
1. The seven rules of a great Git commit message (the reference is in each rule)
2. Commit messages language
Commit messages MUST be in english.
Voting should be 👍, 👎 or self-declared abstentions.
Voting will close when all 7 voting members have cast their votes, or at February 9th 2017, at 15:45 BRST. If no minimum quorum (5 members) is met by then, the vote will fail and will have to be restarted.