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

Configure pre-commit hooks #155

Open
sfc-gh-twhite opened this issue Sep 11, 2024 · 0 comments
Open

Configure pre-commit hooks #155

sfc-gh-twhite opened this issue Sep 11, 2024 · 0 comments

Comments

@sfc-gh-twhite
Copy link
Collaborator

There are several commits taking place in each PR to perform linting tasks.

I would encourage using something like pre-commit to ensure all standards are upheld appropriately and block commits that introduce violations.

The initial run on all files will likely introduce several diffs, so we will want to ensure any outstanding PRs are addressed to avoid needing to merge or rebase.

Here's an example of a pre-commit configuration file as a starting point:

repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0
    hooks:
    -   id: trailing-whitespace
    -   id: end-of-file-fixer
    -   id: check-yaml
    -   id: check-added-large-files
    -   id: requirements-txt-fixer
-   repo: https://github.com/codespell-project/codespell
    rev: v2.3.0
    hooks:
    -   id: codespell
-   repo: https://github.com/psf/black-pre-commit-mirror
    rev: 24.8.0
    hooks:
    -   id: black
-   repo: https://github.com/pycqa/isort
    rev: 5.13.2
    hooks:
      - id: isort
        args: ["--profile", "black", "--filter-files"]
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

No branches or pull requests

1 participant