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.

Sign up for GitHub

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

Jump to bottom

As a developer I want hooks to enforce code quality checks, formatter execution, and unit tests #22

Closed
MJJoyce opened this issue Aug 4, 2021 · 0 comments · Fixed by #27
Closed

As a developer I want hooks to enforce code quality checks, formatter execution, and unit tests #22

MJJoyce opened this issue Aug 4, 2021 · 0 comments · Fixed by #27
Assignees
@MJJoyce
Labels
B12.0 enhancement New feature or request
Milestone
12.Roger.Bannister

Comments

@MJJoyce
Copy link
Contributor

MJJoyce commented Aug 4, 2021

💪 Motivation

...so that we can provide a guaranteed baseline of quality when a new pull request is created.

⚙️ Engineering Details

There's a few approaches that we could take here including just normal git hooks. I've had good luck using pre-commit to manage this. It's pip install-able and makes the handling of these trivial. We could provide a default config file that automatically runs a formatter, linter, and executes unit tests on commit or push.
@MJJoyce MJJoyce assigned jordanpadams and MJJoyce and unassigned jordanpadams Aug 4, 2021
@MJJoyce MJJoyce added this to the 11.Jesse.Owens milestone Aug 4, 2021
@MJJoyce MJJoyce changed the title As a developer I want to hooks to enforce code quality checks, formatter execution, and unit tests As a developer I want hooks to enforce code quality checks, formatter execution, and unit tests Aug 6, 2021
MJJoyce added a commit that referenced this issue Aug 6, 2021
@MJJoyce
Issue #22 - Add pre-commit
202338a 
Add pre-commit and configuration to run mypy, black, flake8, and pytest
automatically on commit / push.

Resolve #22
@MJJoyce MJJoyce mentioned this issue Aug 6, 2021
Merged
MJJoyce added a commit that referenced this issue Aug 7, 2021
@MJJoyce
Issue #22 - Make install docs more 'documenty'
78e87e7
MJJoyce added a commit that referenced this issue Aug 10, 2021
@MJJoyce
Issue #22 - Add pre-commit
4630192 
Add pre-commit and configuration to run mypy, black, flake8, and pytest
automatically on commit / push.

Resolve #22
MJJoyce added a commit that referenced this issue Aug 10, 2021
@MJJoyce
Issue #22 - Make install docs more 'documenty'
4df5d11
MJJoyce added a commit that referenced this issue Aug 10, 2021
@MJJoyce
Merge pull request #27 from NASA-PDS/issue-22
683856c 
Issue #22 - Add pre-commit
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MJJoyce MJJoyce

Labels
B12.0 enhancement New feature or request
Projects
None yet
Milestone
12.Roger.Bannister
Development

Successfully merging a pull request may close this issue.

Issue #22 - Add pre-commit NASA-PDS/template-repo-python
3 participants
@MJJoyce @jordanpadams @tloubrieu-jpl