From 3d777b434838bf5074f6c06b4f379526e54f01b2 Mon Sep 17 00:00:00 2001 From: Thomas Pierce Date: Fri, 21 Jun 2024 09:41:00 -0700 Subject: [PATCH] Update CONTRIBUTING.md for PR best practices Clarify expectations around PRs. --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d949bbcbc..eea3afcc3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,9 @@ Contributions via pull requests are much appreciated. Before sending us a pull r 1. You are working against the latest source on the *main* branch. 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. 3. You open an issue to discuss any significant work - we would hate for your time to be wasted. +4. 4. You are not mixing substantial refactoring changes in with functional changes. + 1. If refactoring is desirable, publish a separate refactoring PR first, followed by a functional change PR. This will ensure safe and efficient reviews. + 2. PRs that do not meet these expectations will be rejected. To send us a pull request, please: @@ -32,6 +35,7 @@ To send us a pull request, please: 4. Commit to your fork using clear commit messages. 5. Send us a pull request, answering any default questions in the pull request interface. 6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. +7. Please do not squash commits between revisions, this makes review challenging, as the diff between revisions is harder to find and review. GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).