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

Update gitignore, flake8, and pre-commit config files #101

Merged
merged 7 commits into from
Feb 27, 2024

Conversation

willingc
Copy link
Collaborator

Addresses #78.

This PR updates and documents the following configuration files:

  • .gitignore (use standard Python gitignore and move pyosMeta specific items to end)
  • .flake8 (explain ignored rules and add a code complexity check)
  • .precommit.config.yaml (improve comments for maintainability and new contributor friendliness)

@willingc willingc added maintenance automation Automate workflows and CI labels Feb 24, 2024
@willingc willingc requested a review from lwasser February 24, 2024 17:51
Copy link

codecov bot commented Feb 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 41.64%. Comparing base (b3fae4e) to head (4f0570c).
Report is 10 commits behind head on main.

❗ Current head 4f0570c differs from pull request most recent head 16d2013. Consider uploading reports for the commit 16d2013 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #101   +/-   ##
=======================================
  Coverage   41.64%   41.64%           
=======================================
  Files           4        4           
  Lines         461      461           
  Branches       74       74           
=======================================
  Hits          192      192           
  Misses        268      268           
  Partials        1        1           

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

Copy link
Member

@lwasser lwasser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@willingc thank you for this. see what you think about removing some of the things we don't need or let me know if you think we should keep the default as is. once we clean this up we can merge this. approving!

.gitignore Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
# Configuration reference doc: https://pre-commit.com/#pre-commit-configyaml---top-level

# Developers
# You may want to install pre-commit to run locally on each minimum_pre_commit_version
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you this is wonderful!

willingc and others added 4 commits February 26, 2024 16:44
Co-authored-by: Leah Wasser <leah@pyopensci.org>
Co-authored-by: Leah Wasser <leah@pyopensci.org>
Co-authored-by: Leah Wasser <leah@pyopensci.org>
Co-authored-by: Leah Wasser <leah@pyopensci.org>
@willingc willingc merged commit c42e9d0 into pyOpenSci:main Feb 27, 2024
2 checks passed
@willingc willingc deleted the review-config branch February 27, 2024 00:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation Automate workflows and CI maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants