Skip to content
This repository was archived by the owner on Apr 28, 2023. It is now read-only.

Commit df36d16

Browse files
authored
Merge pull request #335 from facebookresearch/pr/commit
explicitly mention requirement for commit messages in CodingConvention.md
2 parents f89c4cf + 9d6015e commit df36d16

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CodingConventions.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -589,6 +589,16 @@ as long as the pieces are recombined (e.g., through an interactive rebase)
589589
into logical units when the feature is ready for merging.
590590
Force-pushing in PR branches is fine.
591591

592+
Each commit should have a proper commit message.
593+
A commit message consists of a one-line summary, followed by an empty line and
594+
the main body with more details focusing on the motivation of the change.
595+
Both the one-line summary and the lines in the main body
596+
should not exceed 80 characters.
597+
The commit message should contain all the information that is needed
598+
to understand the change within the git repository.
599+
The main body can only be omitted if the motivation is completely obvious
600+
from the one-line summary for an independent observer.
601+
592602
Coding Conventions for writing Tensor Comprehensions
593603
====================================================
594604

0 commit comments

Comments
 (0)