docs: honest README test output + correct OPENAI_MODEL default#1
Merged
Conversation
The README "Example Test Output" claimed 44 passing tests, 85% coverage, and listed test files that do not exist (test_article_repository.py, test_agent/test_trend_analyzer.py, test_notifications/test_notifier.py). Replace it with real pytest output: 52 passed, 29% coverage, and the actual test-file list, plus an honest note on coverage scope. Also fix the OPENAI_MODEL default in the config table (was gpt-4o) to match settings.py and .env.example (gpt-4o-mini). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Add .github/workflows/quality.yml running ruff + pytest (hard gates) and mypy (non-blocking) on every push/PR, so the build status reflects real lint/test results instead of only that the agent ran. - Fix all ruff findings: remove unused imports (pathlib.Path, urljoin, models.Article) and move a module constant below the imports in trend_analyzer.py (E402). Verified locally: ruff clean, 52 tests pass. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Owner
Author
Follow-up commit — CI + lint (P2)Added on top of the README fix:
Verified locally and in CI: |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
P1 (credibility) fix from a deep-review pass: the README contained fabricated test evidence and a wrong default in the config table.
Changes
📝
docs— honest "Example Test Output"The block claimed 44 passed / 85% coverage and listed test files that don't exist (
test_article_repository.py,test_agent/test_trend_analyzer.py,test_notifications/test_notifier.py). Replaced with realpytestoutput: 52 passed / 29% coverage and the actual file list, plus an honest note on coverage scope.⚙️
docs— correctOPENAI_MODELdefaultConfig table listed
gpt-4o, butsettings.pyand.env.exampleboth default togpt-4o-mini(the cost-efficient default actually used by the scheduled run). Fixed the table togpt-4o-mini.Verification
Docs-only change; no source or test behaviour modified.
Out of scope (tracked separately)
CI test/lint gate, broader coverage,
notifier.pydecomposition.🤖 Generated with Claude Code