search

scribe-org / Scribe-Data

Wikidata, Wiktionary and Wikipedia language data extraction
GNU General Public License v3.0
30 stars 69 forks source link

Add pre-commit hooks and checks to the project #137

Closed andrewtavis closed 5 months ago

andrewtavis commented 5 months ago

Terms

Description

This issue would focus on adding in pre-commit to Scribe-Data such that linting, formatting and other checks could be ran on commit to avoid them being sent to the repo. Directions on how to setup pre-commit would further need to be added to the readme and contributing guide :)

Contribution

Would be happy to support or get to this as I can! This would also be a good first issue for someone who has some Python experience or experience setting up pre-commit 😊

kush34 commented 5 months ago

Hey, this looks easy, I am working on this. can I ask if any help is needed?

andrewtavis commented 5 months ago

Hey @kush34 👋 Sure thing! Happy to help if you need :) You can checkout the pre-commit config file for another project I work on here. Generally the thing to do is use pre-commit sample-config > .pre-commit-config.yaml that'll give us the file, and then from there we can add in the ruff hooks that are in the config file I linked. From there pre-commit install, and then we know it works with pre-commit run --all-files 😊

andrewtavis commented 5 months ago

You'd also be welcome to pick up the other issue we have for this - https://github.com/scribe-org/Scribe-iOS/issues/450 - once this one is finished!

andrewtavis commented 5 months ago

Closed via #141 :) Thanks for the help here, @kush34! Feel free to write in https://github.com/scribe-org/Scribe-iOS/issues/450 if you have interest in working on that one as well 😊