Skip to content

Commit

Permalink
Add PR workflow to contribution guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
msuozzo committed May 28, 2024
1 parent 36d8fdd commit 2326850
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 2326850

Please sign in to comment.