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

Enable pre-commit.ci #16

Merged
merged 16 commits into from
Mar 5, 2024
Merged

Enable pre-commit.ci #16

merged 16 commits into from
Mar 5, 2024

Conversation

jmgate
Copy link
Collaborator

@jmgate jmgate commented Mar 4, 2024

Type: Task

Description

Set up this repository with pre-commit.ci to enforce various things automatically (code formatting, documentation style, etc.).

Motivation

Just settings things up such that we keep everything clean from here on out.

Testing

Note the pre-commit.ci - pr check below. Clicking the Details link shows you all the passing checks.

Commits

  1. chore: Add pre-commit configuration (98c4b48)

    Only enable standard pre-commit hooks to begin with.

  2. style: Ensure files end with a single blank line (41735da)

  3. chore: Enable black pre-commit hook (f1c5c86)

  4. style: Update files to match black style (cd58f9c)

  5. chore: Enable pygrep pre-commit hooks (5aba441)

  6. chore: Enable doc8 pre-commit hook (cf98d36)

  7. chore: Enable flake8 pre-commit hook (76ba088)

  8. style: Switch to idiomatic type check (f47e1bf)

  9. chore: Enable isort pre-commit hook (09f0c46)

  10. style: Sort imports (a66c3cf)

  11. chore: Enable pydocstyle pre-commit hook (472bfc4)

  12. style: Adhere to documentation style guide (3cb946d)

  13. chore: Enable pyroma pre-commit hook (0415cac)

  14. chore: Remove UNIX classifier (69927ce)

    For some reason, Pyroma thinks this is a non-standard classifier.

  15. chore: Remove YAPF disable flags (39fff4e)

    We've transitioned fro YAPF to black for formatting.

  16. docs: Remove bandit badge (fb9c508)

    Until we turn the bandit pre-commit hook on and deal with all the issues found.

Only enable standard pre-commit hooks to begin with.
@jmgate jmgate force-pushed the test-pre-commit-ci branch from 98da09a to 98c4b48 Compare March 4, 2024 18:11
@jmgate jmgate changed the title test: DO NOT MERGE Enable pre-commit.ci Mar 5, 2024
@jmgate jmgate merged commit c743191 into master Mar 5, 2024
5 checks passed
@jmgate jmgate deleted the test-pre-commit-ci branch March 5, 2024 21:04
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.

1 participant