-
Notifications
You must be signed in to change notification settings - Fork 132
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
🚨 Apply automatic formatting #474
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @tdegeus
Besides questions marked inline, one more remark: There's now a ton of rules to be enforced. Maybe a bit more than I would have chosen, but that's not necessarily a problem ;-) Instead, I worry that this makes the use of pre-commit essentially mandatory. This however must not happen - the hurdle for anyone to contribute should be as low as possible.
I won't object to the strict rules (there's much good to them, probably, after all), but I think we should provide simple rules to what everyone can execute locally to make their code compatible, where possible. (Something that would have been pip install -e .[lint] && black bibtexparser tests && isort bibtexparser tests --profile black
or alike). A simple instruction in the contribution guideline on how to enable pre-commit (or at least a link to the corresponding docs) would probably not hurt either - again, just to make it as simple as possible for everyone.
I could completely support supporting a second way to run these tools locally. It would be nice though to enforce keeping their settings in sync (which would be assured if we decide to go back to the default for
and we should definitely document. |
Thanks for your comment. Sounds all good. I'll give the "formal" ( 😄 ) approval after the documentation update has been committed. |
Done ( |
Thanks a lot. We now have two contribution docs: The one on readthedocs and the |
Thanks, sorry I overlooked that. Fixed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome. Thanks
Fixes #464