#32165 closed New feature (fixed)
Add pre-commit Hooks
| Reported by: | David Smith | Owned by: | David Smith |
|---|---|---|---|
| Component: | Packaging | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Adam Johnson | Triage Stage: | Ready for checkin |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
To add support for pre-commit hooks via pre-commit. Specifically, I propose to add the flake8 and isort hooks, with appropriate guidance added to the contributing docs.
The aim is to reduce the number of PRs opened where a 'simple' lint error needs to be fixed, and in doing so we end up running the whole test suite at Jenkins twice. I appreciate this won't stop all instances as folk will have an extra step to install them; however, I think even if it stops the occasional occurrence the addition will be worthwhile.
Change History (7)
comment:1 by , 3 years ago
| Resolution: | → needsinfo |
|---|---|
| Status: | new → closed |
comment:2 by , 3 years ago
| Cc: | added |
|---|
comment:3 by , 3 years ago
| Component: | Uncategorized → Packaging |
|---|---|
| Has patch: | set |
| Resolution: | needsinfo |
| Status: | closed → new |
| Triage Stage: | Unreviewed → Ready for checkin |
| Type: | Uncategorized → New feature |
(This is about GitHub process. I have no idea what component to assign it to really.)
comment:4 by , 3 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
comment:6 by , 3 years ago
In 3a0ed0ce:
Refs #31265 -- Updated .eslintignore to match eslint tests
(Moved comment due to wrong ticket number)
Note:
See TracTickets
for help on using tickets.
Hi David. I'd be inclined to accept this — I think pre-commit is great — but I think we need to go via the DevelopersMailingList first to gather consensus.
Ref DEP 8 this would be handy to have in place.
Can I get you to post to the list? Some thoughts...
Thanks