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

[FEATURE] Workflow to enforce linting/styling #30

Closed
teald opened this issue Jul 16, 2024 · 0 comments · Fixed by #38
Closed

[FEATURE] Workflow to enforce linting/styling #30

teald opened this issue Jul 16, 2024 · 0 comments · Fixed by #38
Assignees
Labels
enhancement New feature or request maintenance For maintenance tasks PyOpenSci Review Part of a PyOpenSci Review

Comments

@teald
Copy link
Member

teald commented Jul 16, 2024

Is your feature request related to a problem? Please describe or write "N/A".
N/A

Describe the solution you'd like

Right now the linting is done as part of the pre-commit process, controlled in pre_commit_config.yaml. This will not run in certain scenarios:

  • Using github to modify files.
  • Forgetting to run pre-commit install before committing to the repo.

As part of the PyOpenSci review process, this was noted by one of the reviewers (see Additional Context for a link to the submission).

The most straightforward solution is to have a workflow run pre-commit on target files (similar to how pre-commit itself works normally).

Describe alternatives you've considered
N/A

Additional context

@teald teald added enhancement New feature or request maintenance For maintenance tasks labels Jul 16, 2024
@teald teald self-assigned this Jul 16, 2024
@teald teald linked a pull request Jul 31, 2024 that will close this issue
@teald teald closed this as completed in #38 Jul 31, 2024
@teald teald added the PyOpenSci Review Part of a PyOpenSci Review label Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request maintenance For maintenance tasks PyOpenSci Review Part of a PyOpenSci Review
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant