From 2326850b742f51c9d53d466d87bdc504bcde7712 Mon Sep 17 00:00:00 2001 From: Matthew Suozzo Date: Thu, 23 May 2024 15:35:54 -0400 Subject: [PATCH] Add PR workflow to contribution guide. --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b5b5a8e..81a186eb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,3 +30,15 @@ This project follows All submissions, including submissions by project members, require review. We use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests) for this purpose. + +### Commit Structure + +Pull Requests may use either Squash and Rebase PR merge strategies. For more +background, see +[the docs](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github)) +but to summarize: + +- _Squash_: All PR commits are combined into one commit when merged. +- _Rebase_: All PR commits are merged as-is. + +Feel free to cater your PR to whichever workflow you prefer.