opensafely-core / opensafely-core/opencodelists
Add pre-commit hook for email addresses
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 60
- Forks
- 16
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 17
Description
Why are we doing this?
We now have a pre-commit hook to check staged files for strings which look like personal email addresses. This will stop us from accidentally committing or pushing email addresses.
🧵 Thread.
How will we know when it's done?
All developers working on OpenCodelists are using this pre-commit hook before committing or pushing changes.
What are we doing?
Follow the instructions in the README to install the pre-commit hook and test that it works as expected for this repo.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked emailcheck README to understand installation and testing, then inspect the repository's existing pre-commit setup. Test the hook against staged files containing and not containing email-like strings. Done means the hook is installed for this repository and works as expected before commits or pushes.
Written by the indexing model from the issue text.
Assessment
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100