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

Add pre-commit setup #356

Merged
merged 10 commits into from Apr 24, 2023
Merged

Add pre-commit setup #356

merged 10 commits into from Apr 24, 2023

Conversation

stefmolin
Copy link
Contributor

@stefmolin stefmolin commented Apr 24, 2023

Issue number of the reported bug or feature request: closes #355

Describe your changes

  • Added pre-commit to extra requirements
  • Created the .pre-commit-config.yaml file
  • Updated contributing instructions on enabling pre-commit for local development
  • Fixed issues in various files.

Testing performed

  1. Installed pre-commit and set it up. All commits in this PR used the checks.
  2. Ran all hooks against all files: pre-commit run --files *

Additional context
I also added some pre-commit hooks that I like to work. These are in the top two sections of the YAML file.

@stefmolin stefmolin marked this pull request as ready for review April 24, 2023 15:26
Signed-off-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com>
Signed-off-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com>
Signed-off-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com>
Signed-off-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com>
Signed-off-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com>
This check is to naive for our needs. It doesn't see our Sphinx
configuration, and is unaware of Intersphinx, so it doesn't realize that
something single quoted can be a reference to an object with the default
Sphinx role configured in `docs/conf.py`.

Signed-off-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com>
Signed-off-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com>
Signed-off-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com>
Signed-off-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com>
Signed-off-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com>
Copy link
Contributor

@godlygeek godlygeek left a comment

Choose a reason for hiding this comment

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

LGTM

@godlygeek godlygeek enabled auto-merge (rebase) April 24, 2023 17:10
@godlygeek godlygeek merged commit 0f0a593 into bloomberg:main Apr 24, 2023
25 checks passed
@stefmolin stefmolin deleted the add-pre-commit branch April 24, 2023 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Switch to using pre-commit for managing our linting setup
2 participants