Skip to content

Commit

Permalink
Copy "Working on this repo" section from nextstrain/ingest
Browse files Browse the repository at this point in the history
  • Loading branch information
joverlee521 committed Aug 13, 2024
1 parent 398dfa3 commit ae250d8
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,26 @@ and workflow organization that is expected of a Nextstrain maintained pathogen.
However, the workflows will require customizations to support your specific pathogen
and should not be expected to "just work".

## Working on this repo

This repo is configured to use [pre-commit](https://pre-commit.com),
to help automatically catch common coding errors and syntax issues
with changes before they are committed to the repo.

If you will be writing new code or otherwise working within this repo,
please do the following to get started:

1. [install `pre-commit`](https://pre-commit.com/#install) by running
either `python -m pip install pre-commit` or `brew install
pre-commit`, depending on your preferred package management
solution
2. install the local git hooks by running `pre-commit install` from
the root of the repo
3. when problems are detected, correct them in your local working tree
before committing them.

Note that these pre-commit checks are also run in a GitHub Action when
changes are pushed to GitHub, so correcting issues locally will
prevent extra cycles of correction.

[Creating a pathogen repository]: https://docs.nextstrain.org/en/latest/tutorials/creating-a-pathogen-repo/index.html

0 comments on commit ae250d8

Please sign in to comment.