CONTRIBUTING.md

(This document uses RFC 2119 keywords.)

Pull Requests

1. Commit messages MUST use this format and this style.

2. Pull requests MUST be about only one topic.

   This way, changes can be seen and discussed individually.

3. Pull requests MUST be rebased on the latest main from the upstream repository:

   # add the upstream repository as remote
   git remote add upstream \
     https://github.com/idiv-biodiversity/ansible-role-systemd-timesyncd.git
   
   # fetch latest upstream commits
   git fetch upstream
   
   # rebase your branch on main
   git rebase upstream/main topic/name
   
   # force push the changed history
   # this will automatically update the pull request
   git push --force origin topic/name

4. Pull requests SHOULD NOT be done in main:

   git switch -c topic/name

   This is not strictly necessary for small changes, e.g. fixing typos in README.md.