Farama-Foundation / stable-retro

Retro games for Reinforcement Learning
https://stable-retro.farama.org/
MIT License
162 stars 34 forks source link

New pre-commit hooks #38

Closed victorsevero closed 1 year ago

victorsevero commented 1 year ago

These were the other pre-commit hooks I considered adding to this project a month ago. What are your thoughts?

I haven't run them on all files of the repo, I wanted to make this PR as clean as possible at first. Let me know if you think it's a good idea to run them before merging (in case of approval) or if we should open a new PR for that.

EDIT: didn't know that pre-commit was already running for all files in GH Actions. Nice! EDIT²: I decided to remove C/C++ formatting and linting since it seems broken and not maintained anymore. I also removed the pydocstyle since we have so many files with no docs at all (but I'd love to enforce that in the future).

victorsevero commented 1 year ago

Thanks for removing the TOC plugin from pre-commit but could you remove all of the instances that it added to the code in the markdown files

Sorry! I only searched for .MD (uppercase) files when I was reverting these changes. I'll remove that.