Using `.pre-commit-config` as a linter and test link check
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 459
- Forks
- 90
- PR merge metrics
- No merged PRs in 30d
Description
I guess pre-commit is a good suggestion to let the project clean, and also check the new PRs if they correspond to the linting rules.
For example:
- I use https://github.com/pre-commit/pre-commit-hooks for checking:
hooks:
- id: check-merge-conflict
- id: check-added-large-files
- id: check-ast
- id: check-symlinks
- id: trailing-whitespace
- id: check-json
- id: debug-statements
- id: pretty-format-json
- For sorting imports, I use https://github.com/PyCQA/isort with the black profile.
- I use https://gitlab.com/pycqa/flake8 also for applying all style rules.
I will try to describe this issue in a PR.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue proposes a .pre-commit-config using pre-commit-hooks, isort with the black profile, and flake8; begin by checking the repository's current lint and test workflow. Done means the agreed hooks run successfully and new pull requests are checked against the project's linting rules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100