Skip to content

Commit 5cc5861

Browse files
authored
Merge pull request #821 from aws-observability/thpierce-patch-1
Update CONTRIBUTING.md for PR best practices
2 parents 077e781 + 3d777b4 commit 5cc5861

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
2323
1. You are working against the latest source on the *main* branch.
2424
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
2525
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
26+
4. 4. You are not mixing substantial refactoring changes in with functional changes.
27+
1. If refactoring is desirable, publish a separate refactoring PR first, followed by a functional change PR. This will ensure safe and efficient reviews.
28+
2. PRs that do not meet these expectations will be rejected.
2629

2730
To send us a pull request, please:
2831

@@ -32,6 +35,7 @@ To send us a pull request, please:
3235
4. Commit to your fork using clear commit messages.
3336
5. Send us a pull request, answering any default questions in the pull request interface.
3437
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
38+
7. Please do not squash commits between revisions, this makes review challenging, as the diff between revisions is harder to find and review.
3539

3640
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
3741
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).

0 commit comments

Comments
 (0)