opensafely / opensafely/documentation

Consider running the `pre-commit` checks in build workflow

Open
#945 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
48
Forks
10
Avg merge
2d 19h
Merged PRs (30d)
17

Description

We currently don't. It might catch a few things, like trailing whitespace. It might also be frustrating, so undecided.

Contributor guide

Open the contributing guide

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.

Research direction

Inspect the build workflow and the current pre-commit checks first, then assess whether running them there would catch issues such as trailing whitespace without creating an unreasonable burden. Done means the project has a decided approach and, if adopted, the build workflow runs the agreed checks.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.