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.

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

Add pre-commit #46

Merged
merged 3 commits into from
Oct 23, 2023
Merged

Add pre-commit #46

merged 3 commits into from
Oct 23, 2023

Conversation

kaitj
Copy link
Contributor

@kaitj kaitj commented Oct 23, 2023

Proposed changes
This PR adds pre-commit hooks to the repo. If the user chooses to set this up (recommended), then the linting and formatting steps are automatically performed everytime there is a new commit, whihc should minimize the occurance of failing checks during a PR as a result of forgetting to run the quality command. Note, rather than use remotely maintained hooks, this makes use primarily makes use of the local tools installed with development dependencies. The alternative option is to run poetry run poe quality, which performs the same things.

A note has been added to the README regarding the pre-commit.

Types of changes
What types of changes does your code introduce? Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other (if none of the other choices apply)

Checklist
Put an x in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask!

  • Changes have been tested to ensure that fix is effective or that a feature works.
  • Changes pass the unit tests
  • Code has been run through the poe quality task
  • I have included necessary documentation or comments (as necessary)
  • Any dependent changes have been merged and published

Notes
All PRs will undergo the unit testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.

@kaitj kaitj added the maintenance Updates or improvements that do not change functionality of the code label Oct 23, 2023
@codecov
Copy link

codecov bot commented Oct 23, 2023

Codecov Report

Merging #46 (032e8db) into main (effd667) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #46   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           12        12           
  Lines          760       760           
=========================================
  Hits           760       760           
Components Coverage Δ
afids_utils/afids.py ∅ <ø> (∅)
afids_utils/ext 100.00% <ø> (ø)
afids_utils/metrics.py 100.00% <ø> (ø)
afids_utils/transforms.py 100.00% <ø> (ø)

@kaitj kaitj merged commit f4e49dd into afids:main Oct 23, 2023
25 checks passed
@kaitj kaitj deleted the maint/pre-commit branch October 23, 2023 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Updates or improvements that do not change functionality of the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant