Skip to content

docs(dev-guide): add guideline for atomic commits to the developer guide #3969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rami3l merged 1 commit into from
Jul 30, 2024
Merged

docs(dev-guide): add guideline for atomic commits to the developer guide #3969

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion doc/dev-guide/src/coding-standards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down