Skip to content
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

Features/black #134

Closed
wants to merge 54 commits into from
Closed

Features/black #134

wants to merge 54 commits into from

Conversation

mccrindlebrian
Copy link
Contributor

@mccrindlebrian mccrindlebrian commented Mar 1, 2024

This PR forces black to be a part of the commit process to our repo. Using setup_precommit.py, it will write a black formatter as a pre-commit took and write it to .git/hooks/pre-commit. It will also run this script as an executable, making it run each time you run git commit.

By doing this, we have a common formatting for us as developers, and we don't have to rely on a github action to do this for us.

All you need to do is run python setup_precommit.py

@p-ferreira
Copy link
Contributor

So the script is executed by the user, e.g. python setup_precommit.py, is that correct? Is there any other integration beyond the manual execution of this script?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if this file is moved to scripts where we have a README.md documentation for the scripts we support?

@steffencruz steffencruz changed the base branch from pre-staging to staging March 7, 2024 22:07
@mccrindlebrian mccrindlebrian deleted the features/black branch March 11, 2024 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants