Skip to content

Commit

Permalink
Merge 04177d7 into ba983a4
Browse files Browse the repository at this point in the history
  • Loading branch information
zslade committed Feb 15, 2022
2 parents ba983a4 + 04177d7 commit 2a179ca
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,20 @@ You can find a short video introducing `splink` and running though an introducto

A 'best practices and performance tuning' tutorial can be found [here](https://www.youtube.com/watch?v=HzcqrRvXhCE).

## How to make changes to Splink

(Steps 5 onwards for contributors only)

1. Raise new issue or target existing issue
2. Create new branch (usually off master)
3. Make changes, commit and push to GitHub
4. Make pull request, referencing the issue
5. Wait for tests to pass
6. Review pull request
7. Bump Splink version in [pyproject.toml](https://github.com/moj-analytical-services/splink/blob/master/pyproject.toml) and update [CHANGELOG.md](https://github.com/moj-analytical-services/splink/blob/master/CHANGELOG.md) as part of pull request
8. Merge
9. Release on PyPI and create new tag

## Acknowledgements

We are very grateful to [ADR UK](https://www.adruk.org/) (Administrative Data Research UK) for providing funding for this work as part of the [Data First](https://www.adruk.org/our-work/browse-all-projects/data-first-harnessing-the-potential-of-linked-administrative-data-for-the-justice-system-169/) project.
Expand Down

0 comments on commit 2a179ca

Please sign in to comment.