Skip to content

Conversation

@jm-rivera
Copy link
Collaborator

This pull request introduces several improvements to project infrastructure and documentation, focusing on code quality automation, testing, and clearer changelog practices. The most important changes are the addition of pre-commit hooks for code consistency and safety, integration of automated testing into the release workflow, and a complete rewrite of the changelog to follow best practices. There are also updates to the documentation to reflect the current version and supported Python versions.

Automation and Quality Checks:

  • Added a .pre-commit-config.yaml file configuring a comprehensive set of pre-commit hooks, including Python linting/formatting (Ruff), file quality checks, JSON/YAML validation, security checks, and a hook to run pytest before commits. This helps ensure code consistency, catch errors early, and prevent common mistakes from being committed.

Continuous Integration:

  • Updated .github/workflows/release.yml to add a test job that runs the test suite on Python 3.11 using uv and pytest, and made the release job depend on successful test completion. This enforces that releases are only created if tests pass.

Documentation and Changelog:

  • Rewrote CHANGELOG.md to follow the "Keep a Changelog" format and Semantic Versioning, providing a clear and comprehensive history of changes, additions, and fixes for each release.
  • Updated README.md to display the current package version (2.3.0), clarify that Python 3.11+ is required, and improve the description of supported indicators and databases. [1] [2] [3]

@codecov-commenter
Copy link

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@jm-rivera jm-rivera merged commit 3a4fdeb into main Oct 16, 2025
9 checks passed
@jm-rivera jm-rivera deleted the tests branch October 16, 2025 17:35
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