Skip to content

Commit e4f9737

Browse files
authored
Merge pull request #298 from carlaKC/contribution-fixups
docs: add tips for using fixup commits
2 parents b23aa5f + 5e0c4fc commit e4f9737

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ This project strictly adheres to an [atomic commit structure](https://en.wikiped
3939
When your PR is in review, changes should be made using [fixup commits](https://andrewlock.net/smoother-rebases-with-auto-squashing-git-commits/) to maintain the structure of your commits.
4040
When your PR is complete, reviewers will give the instruction to `squash` the fixup commits before merge.
4141

42+
Some tips for using fixup commits:
43+
- Ordering: put fixup commits directly after the commit they're fixing up. This allows reviewers to use "shift + select" on github to review the full commit, and can easily squash them themselves.
44+
- Use your discretion: if your PR has not had much review yet, or is a single commit then fixups add less value.
45+
- Communication: one set procedure isn't going to fit every PR - if you feel that squashing your fixups would be helpful, ask your reviewer! If you don't think they're worth using at all, motivate why!
46+
4247
For historical reasons, commit titles in the project are formatted as `<scope>/<type>: commit message`. A list of different commit types is available [here](https://graphite.dev/guides/git-commit-message-best-practices#2-types-of-commits).
4348

4449
For example, a commit that refactors the `sim-cli` package will be titled: `sim-cli/refactor: {message about refactor}`.

0 commit comments

Comments
 (0)