[Feature][Docs]: Setting up pre-commit for linting about reviews HOT 7 CLOSED

@yushao2 congratulations on your upcoming devops role 🎉

we could add it to the README as an optional dependancy for development as it will benefit other developers that are new to the project and pre commit hooks.

A small update for what pre commit is, how we use it, steps to install it, and how to initialise it would be a great addition for this issue

pip install pre-commit
pre-commit init

pre-commit run --all

from reviews.

@apoclyps
I think we can close this issue -- I took a look at the docs and I think the current information about it is fine.

The pip requirements has pre-commit included, therefore the command would be sufficient in setting up pre-commit for new devs jumping aboard the project

from reviews.

@apoclyps Kyle, I thought this might be good to have, but feel free to close this issue if you think otherwise

I would take this up and give this a shot -- would probably help me in my upcoming role in DevOps engineering

from reviews.

Oh, my mistake I didn't realise it's already in the repository 😓

from reviews.

@yushao2 congratulations on your upcoming devops role

we could add it to the README as an optional dependancy for development as it will benefit other developers that are new to the project and pre commit hooks.

A small update for what pre commit is, how we use it, steps to install it, and how to initialise it would be a great addition for this issue

pip install pre-commit
pre-commit init

pre-commit run --all

Let me push what I have, and continue tomorrow (it's 3.45 AM where I'm at 😆 )

I've updated the pre-commit config to better reflect the linting steps described in README.md as well.

Thanks for taking a look at this

from reviews.

Good point, I didn't think to check timezone differences. Go get some sleep 👋 Consider all comments/feedback async - there is no urgency to action any of it immediately. always put yourself first :)

from reviews.

closed by #94

from reviews.