Add pre-commit hook for email addresses

Open Beginner friendly
#3,237 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Domain
tooling

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.

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.

Defining delivery tasks guidance

Dominant language
Python
Stars
60
Forks
16
Avg merge
4d 12h
Merged PRs (30d)
17

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from opensafely-core/opencodelists

All issues in opensafely-core/opencodelists

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.