aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/dev/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md
index 5a9c0a148..46ee030fc 100644
--- a/docs/dev/README.md
+++ b/docs/dev/README.md
@@ -261,6 +261,14 @@ fn frobnicate(walrus: Option<Walrus>) {
261} 261}
262``` 262```
263 263
264## Commit Style
265
266We don't have specific rules around git history hygiene.
267Maintaining clean git history is encouraged, but not enforced.
268We use rebase workflow, it's OK to rewrite history during PR review process.
269
270Avoid @mentioning people in commit messages, as such messages create a lot of duplicate notification traffic during rebases.
271
264# Architecture Invariants 272# Architecture Invariants
265 273
266This section tries to document high-level design constraints, which are not 274This section tries to document high-level design constraints, which are not