From daab52f53db470023ee5845bda9ea1e8f9dd8b4b Mon Sep 17 00:00:00 2001 From: Chris Warrick Date: Sun, 21 Jan 2024 10:02:02 +0100 Subject: [PATCH] CONTRIBUTING.rst: inform about squash merges (#3747) --- CONTRIBUTING.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 404fe32a0c..6e50b069eb 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -42,9 +42,13 @@ Here are some guidelines about how you can contribute to Nikola: `_. It’s not necessary, but if you are doing something big, we recommend describing it in the commit message. +* Your Pull Request should have an informative title and description. * While working, rebase instead of merging (if possible). You can use rebase instead of merge by default with ``git config pull.rebase true``. If rebases fail, you can just use ``git pull --no-rebase``. +* We will probably squash your commits when merging the pull request. This means + you don’t need to do this yourself (and it’s easier for us to review pull requests + which don’t squash things on their own). * **Make sure documentation is updated** — at the very least, keep docstrings current, and if necessary, update the reStructuredText documentation in ``docs/``. * **Add a CHANGELOG entry** at the *top* of ``CHANGES.txt`` mentioning the