Mention pre-commit in README
Open
@ctuni is already working on this.
Since Mar 19, 2024.
enhancement
- Dominant language
- MDX
- Stars
- 98
- Forks
- 298
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 38
Description
We should remind users to install pre-commit before pushing changes, otherwise lint check may fail.
Suggest adding an extra step under the Development heading in README.md
Alternatively, add an extra step to CONTRIBUTING.md
This could also be a pointer to https://nf-co.re/docs/contributing/code_formatting
Open to suggestions!
Contributor guide
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.
Assessment
This issue has not been assessed yet.