Skip to content

Commit

Permalink
docs typo
Browse files Browse the repository at this point in the history
  • Loading branch information
ADBond committed Nov 2, 2023
1 parent 5ee172d commit 2988873
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ When making code changes, we recommend:

As mentioned above, we like to keep PRs small and our philosophy on branching reflects that. Splink does not work with a `dev` branch, so all branches/forks should be made from `master` in the first instance.

For small PRs, simply branching from `master` and merging from there is perfectly fine. However, if you have a larger feature to add we tend to try and break these up into chunks. If you have a larger feature, please consider creating a simple minimum-viable feeature and submit for review. Once this has been reviewed by the Splink dev team there are two options to consider:
For small PRs, simply branching from `master` and merging from there is perfectly fine. However, if you have a larger feature to add we tend to try and break these up into chunks. If you have a larger feature, please consider creating a simple minimum-viable feature and submit for review. Once this has been reviewed by the Splink dev team there are two options to consider:

1. Merge minimal feature into master then create a new branch with additional features.
2. Do not merge the initial feature branch and create additional feature branches from the reviewed branch.
Expand Down

0 comments on commit 2988873

Please sign in to comment.