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

ci(pre-commit): format pyproject.toml with pyproject-fmt #453

Merged
merged 5 commits into from
Oct 2, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Sep 26, 2024

Description

This PR adds a pre-commit check and formatting step leveraging pyproject-fmt to help standardize the formatting found within the file, similar to how black or ruff-format work with Python code.

This doesn't tie to an issue for the project but I thought it might be helpful to implement here to keep the pyproject.toml file format consistent.

What is the nature of your change?

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

@codecov-commenter
Copy link

codecov-commenter commented Sep 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.74%. Comparing base (3447370) to head (43e0692).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #453   +/-   ##
=======================================
  Coverage   94.74%   94.74%           
=======================================
  Files          57       57           
  Lines        3156     3156           
=======================================
  Hits         2990     2990           
  Misses        166      166           
Flag Coverage Δ
unittests 94.74% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@d33bs d33bs marked this pull request as ready for review October 1, 2024 22:32
pyproject.toml Outdated Show resolved Hide resolved
Co-Authored-By: Gregory Way <[email protected]>
@d33bs
Copy link
Member Author

d33bs commented Oct 2, 2024

Thanks @gwaybio for the review - going to merge this in!

@d33bs d33bs merged commit cc555f6 into cytomining:main Oct 2, 2024
12 checks passed
@d33bs d33bs deleted the pyproject-formatting branch October 2, 2024 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants