Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CONTRIBUTING.rst: inform about squash merges #3747

Merged
merged 1 commit into from
Jan 21, 2024
Merged

CONTRIBUTING.rst: inform about squash merges #3747

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,13 @@ Here are some guidelines about how you can contribute to Nikola:
<http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_.
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
Expand Down