Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
.pre-commit-config.yamlfile 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 runpytestbefore commits. This helps ensure code consistency, catch errors early, and prevent common mistakes from being committed.Continuous Integration:
.github/workflows/release.ymlto add atestjob that runs the test suite on Python 3.11 usinguvandpytest, and made the release job depend on successful test completion. This enforces that releases are only created if tests pass.Documentation and Changelog:
CHANGELOG.mdto follow the "Keep a Changelog" format and Semantic Versioning, providing a clear and comprehensive history of changes, additions, and fixes for each release.README.mdto 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]