lightly-ai / lightly

A python library for self-supervised learning on images.
https://docs.lightly.ai/self-supervised-learning/
MIT License
2.89k stars 249 forks source link

docs(contributing): refactor `pre-commit` instructions #1582

Closed SauravMaheshkar closed 4 weeks ago

SauravMaheshkar commented 1 month ago

At the moment, the pre-commit instructions aren't linked from anywhere. This PR updates the contributing guide by linking the pre-commit instructions.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 81.82%. Comparing base (c802af8) to head (a3835bc).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1582 +/- ## ======================================= Coverage 81.82% 81.82% ======================================= Files 145 145 Lines 6140 6140 ======================================= Hits 5024 5024 Misses 1116 1116 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

guarin commented 1 month ago

I also saw that PRECOMMITHOOKS.md still refers to requirements/dev.txt which doesn't exist anymore. Could you update that part as well?

SauravMaheshkar commented 1 month ago

I also saw that PRECOMMITHOOKS.md still refers to requirements/dev.txt which doesn't exist anymore. Could you update that part as well?

Addressed in ebdb09f