Review code quality and documentation #1
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Fix pyproject.toml license: MIT → AGPL-3.0 with correct classifier - Fix README.md license badge link to point to GNU AGPL page - Fix docs/configuration.md config file search paths to match code - Fix docs/architecture.md SQL schema to match actual implementation: - alert_states → alert_state (correct table name) - delivery_log → deliveries (correct table name) - Updated schema definitions to match sqlite.py
- Add scripts/check-docs.py for documentation consistency validation - License consistency across files - Table names match actual code - Config file paths match implementation - Version consistency between pyproject.toml and __init__.py - Update CI workflow: - Require 80% test coverage (--cov-fail-under=80) - Run documentation consistency check - Validate CHANGELOG format (version headers, [Unreleased] section) - Update pyproject.toml: - Add fail_under = 80 for coverage - Add show_missing for better coverage reports - Fix CHANGELOG.md: - Move schema drift detection to v0.1.0 (already implemented) - Update release date to 2025-01-15
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.