From c5141d482e311f33134476a8a0c809abf2561312 Mon Sep 17 00:00:00 2001 From: Josh Hsieh Date: Mon, 29 Jul 2024 23:48:33 +0800 Subject: [PATCH] docs(dev-guide): add guideline for atomic commits to the developer guide docs(dev-guide): put atomic commits at the beginning --- doc/dev-guide/src/coding-standards.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/dev-guide/src/coding-standards.md b/doc/dev-guide/src/coding-standards.md index 0c03207aa6..f1d0f7fa9f 100644 --- a/doc/dev-guide/src/coding-standards.md +++ b/doc/dev-guide/src/coding-standards.md @@ -1,10 +1,14 @@ - # Coding standards Generally we just follow good sensible Rust practices, clippy and so forth. However there are some practices we've agreed on that are not machine-enforced; meeting those requirements in a PR will make it easier to merge. +## Atomic commits + +We use atomic commits across the repo. Each commit should represent a single unit of change. +You can read more about atomic commits [here](https://www.aleksandrhovhannisyan.com/blog/atomic-git-commits). + ## Import grouping In each file the imports should be grouped into at most 4 groups in the