Improve testing for pre-commit hooks
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 30/100
Research direction
Start with the existing pytest tests for the hooks and the .pre-commit-config.yaml setup, then compare the hook tests in the pre-commit repository. Focus on add-license-headers and tech-review, including the listed fixture scenarios and configuration. Done means dummy repositories exercise all relevant hook scenarios without requiring local configuration edits.
Written by the indexing model from the issue text.
Description
Figure out a way to test the pre-commit hooks in the actions.
Currently, the content of the hooks are tested with pytest, but I have to test my hook changes locally by updating the .pre-commit-config.yaml file:
- repo: local
hooks:
- id: add-license-headers
name: "Add License Headers"
entry: add-license-headers
language: python
files: '(src|examples|tests)/.*\.(py)|\.(proto)'
require_serial: true
args:
- --start_year=2023
exclude: |
(?x)^(
tests/test_add_license_headers_files/bad_chars.py |
tests/test_add_license_headers_files/index_error.scss
)$
Next steps
- Look at how hooks are tested in the pre-commit repository & do something similar?
- Create dummy repos for each hook that tests all scenarios for add-license-headers and tech-review respectively
- Dominant language
- Python
- Stars
- 5
- Forks
- 1
- Avg merge
- 1h 47m
- Merged PRs (30d)
- 7
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.
More from ansys/pre-commit-hooks
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
ansys/pre-commit-hooks#115 · 1 comment ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 55/100
ansys/pre-commit-hooks#411 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
ansys/pre-commit-hooks#389 · 2 reactions ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
ansys/pre-commit-hooks#282 · 1 comment · 2 reactions ·
-
enhancement hacktoberfest
Difficulty 3/5 1-2 days Newbie friendliness 35/100
ansys/pre-commit-hooks#199 · 2 comments · 2 reactions ·
All issues in ansys/pre-commit-hooks
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100