From ba20372c23c65122db055e202cfe68fcddafd342 Mon Sep 17 00:00:00 2001 From: Valentin271 <36198422+Valentin271@users.noreply.github.com> Date: Fri, 26 Jan 2024 18:30:15 +0100 Subject: [PATCH] chore(CONTRIBUTING): remove part about squashing commits (#874) Removes the part about squashing commits from the CONTRIBUTING file. We no longer require that because github squashes commits when merging. This will cleanup the CONTRIBUTING file a bit which is already quite dense. --- CONTRIBUTING.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1599417..da631072 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,14 +54,6 @@ describes the nature of the problem that the commit is solving and any unintuiti change. It's rare that code changes can easily communicate intent, so make sure this is clearly documented. -### Clean up your commits - -The final version of your PR that will be committed to the repository should be rebased and tested -against main. Every commit will end up as a line in the changelog, so please squash commits that are -only formatting or incremental fixes to things brought up as part of the PR review. Aim for a single -commit (unless there is a strong reason to stack the commits). See [Git Best Practices - On Sausage -Making](https://sethrobertson.github.io/GitBestPractices/#sausage) for more on this. - ### Run CI tests before pushing a PR We're using [cargo-husky](https://github.com/rhysd/cargo-husky) to automatically run git hooks,