From 9e3299657ed3604437b2b70dfc3c5d7491211f5d Mon Sep 17 00:00:00 2001 From: Graham Date: Tue, 3 Mar 2020 21:00:34 +0000 Subject: [PATCH] Add link to the Git rewriting history page --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 5ff6f3fcd6..baa5ab175e 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,9 @@ Commit messages should follow the ['seven rules'][commitmsg] described in can be up to 72 characters in length (as OpenRS2 does not use email-based patches). +You should use tools such as [interactive rebase][rewriting-history] to ensure +the commit history is tidy. + ### Developer Certificate of Origin OpenRS2 uses version 1.1 of the [Developer Certificate of Origin][dco] (DCO) to @@ -158,4 +161,5 @@ OpenRS2. If not, see . [jdk]: https://jdk.java.net/ [ktlint]: https://github.com/pinterest/ktlint#readme [lgpl]: https://www.gnu.org/licenses/lgpl-3.0.html +[rewriting-history]: https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History [semver]: https://semver.org/