From 9351e33d0b3ac5ce5888698e804830cba8dca815 Mon Sep 17 00:00:00 2001 From: Alexander Borsuk <170263+biodranik@users.noreply.github.com> Date: Sat, 4 Mar 2023 19:02:48 +0100 Subject: [PATCH] [docs] Mention git rebase workflow (#4692) Signed-off-by: Alexander Borsuk --- docs/CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 966b03169c..0597b4b718 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -81,6 +81,12 @@ The OM community abides by the [CNCF code of conduct](CODE_OF_CONDUCT.md). ## Developer's Guidelines +Please [learn how to use `git rebase`](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to amend your commits +and have a clean history for your changes/branches. +Do not close/recreate Pull Requests if you want to edit commits. Use `git rebase` and `git commit --amend`, +or any git tool with a graphical interface ([Fork for Mac](https://git-fork.com/) is quite good) to make clean, +logical commits, properly signed with [DCO](DCO.md). + - [Directories structure](STRUCTURE.md) - [C++ Style Guide](CPP_STYLE.md). - [Java Style Guide](JAVA_STYLE.md).