WayScience / CytoSnake

Orchestrating high-dimensional cell morphology data processing pipelines
https://cytosnake.readthedocs.io
Creative Commons Attribution 4.0 International
3 stars 3 forks source link

Adding pre-commit documentation #25

Closed axiomcura closed 1 year ago

axiomcura commented 1 year ago

Quote source

@axiomcura - thanks, yes, I recommend being clear within documentation on how pre-commit should be used. For example, if another developer were to make a contribution to this repo, how likely would it be that their work would require corrections which could have otherwise been caught by pre-commit (and not a reviewer)? If they could have used pre-commit in such a way to prepare the code in advance of a review, I'd recommend documenting the suggested or required methods for doing so. Specifically I'm meaning running pre-commit for this repo in a broad sense, and not which checks or how those checks work (which is outlined within the configuration file).

Issues focuses on creating a well detailed docuemntation on how developers should be using the cytosnake's pre-commits.