Introduce pre-commit and update documentation

ryansurf / cli-surf

Get surf and ocean data from the command line interface

MIT License

18 stars 31 forks source link

Closed K-dash closed 6 months ago

K-dash commented 6 months ago

Configure pre-commit hooks to run ruff for linting and formatting
- Update documentation to include pre-commit setup and usage instructions
Remove Linter/Formatter tasks from Makefile as they are now handled by pre-commit
Modify CI (linter.yml) to hook into pre-commit's Linter/Formatter

I've taken a stab at updating the documentation, but there might be some areas I've overlooked. If you spot anything, please let me know!

Fixes #29

ryansurf commented 6 months ago

Good stuff! This was much needed (I kept forgetting to run the linter & formatter lol), the documentation looks great too. Merging