NASA-AMMOS / NASA-AMMOS/AIT-Core
Add pre-commit / pre-push pipeline
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 56
- Forks
- 35
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 3
Description
Consider adding a pre-commit hook pipeline for covering common pre-commit / push checks. We could definitely do this via straight git hooks as well but I've found this library to be pretty convenient for managing these sorts of things. I'd suggest we consider hooks that:
- automatically build the API docs
- strip trailing whitespace
- reorder imports
- run code through Black
- run code through flake8
- on push, run the unit test suite
In terms of effort, changes necessary are fairly minimal. I ran flake8 over the codebase after a pass through black and there's a decent amount of errors but nothing terrifying considering the code base size.
Contributor guide
No contributing guide indexed for this repository
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
Start by inspecting the repository's existing Python configuration and test layout, then compare the proposed hooks with the current API-doc build and unit-test process. Done means a pre-commit configuration runs whitespace cleanup, import ordering, Black, flake8, API-doc generation, and the unit suite at the appropriate commit or push stages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, python
- Domain
- build-system, ci-cd, developer-experience, testing
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100