Discussion about PR contribution best practices

Some new best practices were introduced into https://github.com/corona-warn-app/cwa-website/blob/master/CONTRIBUTING.md#pull-request-checklist recently (see below).

I’d like to start this thread as an open discussion to help collaboration and implementing the best practices.

---

Pull Request Checklist

• Use a git GUI interface if you are new to git. It will help you getting familiar with the basic submission workflow.

• Branch from the master branch and also target master with your Pull Request.

• Commits should be as small as possible while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).

  • If you notice a small error in your latest commit, you should amend fixes instead of creating a new commit.
  • If you make several related fixup commits in a row, you should squash them into a single commit.
  • Use restore operations if you want to revert a change in a commit.

• Create Draft pull requests only if you need clarification or an explicit review before you can continue your work item.

• If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment, or you can ask for a review by contacting us via email.

• Post review:

  • Integrate the requested changes into your submission.
  • Set respective comments in your GitHub review to resolved.
  • Rebase your PR to the latest upstream master branch.
  • Create a general PR comment to notify the reviewers that your amendments are ready for another round of review.

[larswmh]

@MikeMcC399 sorry for not following best practices, I’m still learning and will give my best to follow them from now on. I’m not a member of the Open Source Team, I get my information from other people who then assign tasks to me.

[MikeMcC399]

After merging the master branch into a open PR, pulling it locally then adding a commit, GitHub Desktop wouldn’t let me squash. I had to rebase on master then I could squash and force push to origin. Still learning here 🙂 !