Skip to content

Commit 1feba1d

Browse files
committed
conventions: write good commit messages
Signed-off-by: Santiago M. Mola <[email protected]>
1 parent b9c19be commit 1feba1d

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

engineering/repositories.md

+11
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,17 @@ Each repository should belong to a team, and the full team has admin rights over
3030
* A maintainer can merge his own PRs without code review, but it is encouraged to ask for a review Merging without review, if done, should be reserved to fixing typos or minor maintenance tasks.
3131
* If a maintainer is missing, the Lead of the team that the project is owned by, or a backup maintainer designated by him will act as maintainer.
3232

33+
## Commit messages
34+
35+
Commit and Pull Request descriptions should be clear and detailed. Keep in mind that commit messages will be read by (eventually) a lot of people:
36+
37+
- Code reviewers will read them to have context on what they are reviewing, to understand why the change was needed and why it was done in a certain way.
38+
- Any developer might eventually get there when investigating (e.g. git bisect) a regression. They might get there long after the change is introduced and the context forgotten.
39+
- Maintainers might go back to it when writing release notes.
40+
- Any user might read it later to understand a change that affects them.
41+
42+
Take some time to explain what and why you did something. It will save a lot of time to everyone, including yourself.
43+
3344
## Issues
3445

3546
* Maintainers should review GitHub issues and answer them in less than a working day. An answer might be just a "Thank you, we'll look into it" as minimum.

0 commit comments

Comments
 (0)