Skip to content

Commit 03b7c56

Browse files
Josh Hsiehrami3l
authored andcommitted
docs(dev-guide): add guideline for atomic commits to the developer guide
docs(dev-guide): put atomic commits at the beginning
1 parent 82e079d commit 03b7c56

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

doc/dev-guide/src/coding-standards.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
1-
21
# Coding standards
32

43
Generally we just follow good sensible Rust practices, clippy and so forth.
54
However there are some practices we've agreed on that are not machine-enforced;
65
meeting those requirements in a PR will make it easier to merge.
76

7+
## Atomic commits
8+
9+
We use atomic commits across the repo. Each commit should represent a single unit of change.
10+
You can read more about atomic commits [here](https://www.aleksandrhovhannisyan.com/blog/atomic-git-commits).
11+
812
## Import grouping
913

1014
In each file the imports should be grouped into at most 4 groups in the

0 commit comments

Comments
 (0)