Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README to include details on running pre-commit #17

Closed
apulsipher opened this issue Oct 7, 2024 · 0 comments · Fixed by #28
Closed

Update README to include details on running pre-commit #17

apulsipher opened this issue Oct 7, 2024 · 0 comments · Fixed by #28
Assignees
@gvegayon
Labels
documentation Improvements or additions to documentation
Milestone
(v0.2.0) Sprint 2

Comments

@apulsipher
Copy link
Collaborator

This should include:

  • Installation instructions (or pointing to installation instructions)
  • How/why to run it locally
  • What to expect from the output
  • A warning that it will also be run as a PR check and if the pre-commit fails, changes won't be merged
  • Anything else that would be relevant for a developer who has never used pre-commit before
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gvegayon gvegayon

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
(v0.2.0) Sprint 2
Development

Successfully merging a pull request may close this issue.

Adding code of conduct and development documentation EpiForeSITE/epiworld-forecasts
2 participants
@gvegayon @apulsipher