Skip to content

Commit 85e0005

Browse files
ramaraochavalijoeyb
authored andcommitted
docs: added commit guidelines (#9)
Signed-off-by: Rama <[email protected]>
1 parent 2669736 commit 85e0005

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

+20
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,26 @@ maximize the chances of your PR being merged.
1717

1818
* See [STYLE.md](STYLE.md)
1919

20+
## Maintaining clean commit history
21+
22+
The following conventions should be followed for keeping history clean and making code reviews easier
23+
for reviewers:
24+
25+
* First line of commit messages should be in format of
26+
27+
`package-name: summary of change`
28+
29+
for example:
30+
31+
`cache,server: improve caching behaviour`
32+
33+
* Every time you receive a feedback on your pull request, push changes that
34+
address it as a separate one or multiple commits with a descriptive commit
35+
message (try to avoid using vague `addressed pr feedback` type of messages).
36+
37+
Project maintainers are obligated to squash those commits into one when
38+
merging.
39+
2040
# Submitting a PR
2141

2242
* Fork the repo.

0 commit comments

Comments
 (0)