Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos #1691

Merged
merged 2 commits into from
Nov 2, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
docs typo
ADBond committed Nov 2, 2023
commit 2988873ef4843f96eb63fb31c71f6c80e7a1abe4
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.