File tree 1 file changed +20
-0
lines changed
1 file changed +20
-0
lines changed Original file line number Diff line number Diff line change @@ -17,6 +17,26 @@ maximize the chances of your PR being merged.
17
17
18
18
* See [ STYLE.md] ( STYLE.md )
19
19
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
+
20
40
# Submitting a PR
21
41
22
42
* Fork the repo.
You can’t perform that action at this time.
0 commit comments