docs: add a reminder to rebase instead of merge

The only exception is when a PR gets merged into master.
shpaass · Sep 9, 2024 · 79a40a4 · 79a40a4
1 parent ea66305
commit 79a40a4
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/Docs/CodeStyle.md b/Docs/CodeStyle.md
@@ -14,6 +14,7 @@ The main idea is to keep the code maintainable and readable.
 ### Commits
 * Please separate the change of behavior from the refactoring, into different commits. That helps to understand your commits easier.
 * Please make meaningful commit messages. We encourage you to use the prefixes from the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#summary). They help to browse the commits later.
+* Please update your branch by rebasing, not merging. Merges are expected only when a PR merges into master. In all other cases, they complicate the commit history, so please rebase instead.
 
 ### Code
 * In the programmers' haven, there is always a free spot for those who write tests.