docs: update CONTRIBUTING.md with guidance on pull request diffs and …

…commit messages (taikoxyz#12992)
kervsalz · Jan 19, 2023 · 7a007f3 · 7a007f3
1 parent 03540c5
commit 7a007f3
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -29,6 +29,8 @@ After your pull request is merged, a bot will automatically leave a comment with
 
 Specify the scope of your change with a [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) in the PR title (for example, `feat(scope): description of feature`). This will be squashed and merged into the `main` branch.
 
+Because we squash all of the changes into a single commit, please try to keep the PR limited to the scope specified in the commit message. This commit message will end up in the automated changelog by checking which packages are affected by the commit. For example, `feat(scope): description of feature` should only impact the `scope` package. If your change is a global one, you can use `feat: description of feature`, for example.
+
 ### Source code comments
 
 Follow the [NatSpec format](https://docs.soliditylang.org/en/latest/natspec-format.html) for documenting smart contract source code. Please adhere to a few additional standards: