docs: update README for v1.0.0 production release#131
Merged
Conversation
- Status badge: Beta/Stabilising → Production/Stable - Grade badge: B → A - Version: 0.9.0 → 1.0.0 - Release date: March 2026 → April 2026 - Test count: 2,173 → 2,194 passing - Overview: remove stabilisation wording, reflect v1.0.0 shipped - Testing strategy: fix stale "≈10–11%" coverage claim → ≈70%+ - Project Status: rewrite for production release - Recent Achievements: update with v1.0.0 milestones - Planned Improvements: remove "explore asyncio" (shipped), update list Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Reviewer's GuideUpdates README documentation to reflect the v1.0.0 production-stable release, including status/grade badges, version and release metadata, test and coverage metrics, the high-level product overview, detailed testing strategy, and project status/roadmap sections. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The hard-coded test count in the "Tests Passing" badge and the narrative (2,194 tests) is likely to drift over time; consider either omitting the explicit number in prose or driving it from a single source (e.g., just the badge) to avoid future inconsistencies.
- The project grade badge still links to TODO.md while the status badge now links to the latest release; for a production-stable README, it may be clearer to point both badges at more user-facing targets (e.g., releases or main project page) or explain what TODO.md contains.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The hard-coded test count in the "Tests Passing" badge and the narrative (2,194 tests) is likely to drift over time; consider either omitting the explicit number in prose or driving it from a single source (e.g., just the badge) to avoid future inconsistencies.
- The project grade badge still links to TODO.md while the status badge now links to the latest release; for a production-stable README, it may be clearer to point both badges at more user-facing targets (e.g., releases or main project page) or explain what TODO.md contains.
## Individual Comments
### Comment 1
<location path="README.md" line_range="669" />
<code_context>
## Planned Improvements
* Add more package managers support (MacPorts, etc.)
* Implement automatic update capabilities for Homebrew-manageable applications
-* Explore using `asyncio` for network operations
</code_context>
<issue_to_address>
**suggestion (typo):** Consider rephrasing this bullet for correct grammar ("Add support for more package managers").
"Add more package managers support" is ungrammatical. Prefer something like "Add support for more package managers (MacPorts, etc.)" or "Add more package-manager support (MacPorts, etc.)."
```suggestion
* Add support for more package managers (MacPorts, etc.)
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
|
||
| ## Planned Improvements | ||
|
|
||
| * Add more package managers support (MacPorts, etc.) |
Contributor
There was a problem hiding this comment.
suggestion (typo): Consider rephrasing this bullet for correct grammar ("Add support for more package managers").
"Add more package managers support" is ungrammatical. Prefer something like "Add support for more package managers (MacPorts, etc.)" or "Add more package-manager support (MacPorts, etc.)."
Suggested change
| * Add more package managers support (MacPorts, etc.) | |
| * Add support for more package managers (MacPorts, etc.) |
🔒 Security Analysis ReportSecurity Analysis ReportGenerated: Wed Apr 1 16:49:56 UTC 2026 Bandit Security ScanSafety Check ResultsPip-Audit Results |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 82359ea5eb
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| * Effective logical path coverage for core decision branches: substantially higher (most comparison and | ||
| matching branches exercised) | ||
| * High mock call volume (5,000+ patched interactions) reduces counted executable lines while still validating behavior | ||
| * Reported line coverage: ≈70%+ overall |
There was a problem hiding this comment.
The new ≈70%+ overall coverage statement conflicts with the maintained testing documents, which still define the current baseline as ~10–11% and the near-term target as ~25–30% (docs/TESTING_STRATEGY.md:13,78-85 and tests/integration_test_plan.md:12-22). This introduces contradictory guidance for contributors and reviewers about what coverage numbers are expected right now, which can misdirect testing work and acceptance criteria; either the README claim or the referenced test-strategy docs need to be updated together.
Useful? React with 👍 / 👎.
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
0.9.0→1.0.0, release date updated to April 2026🤖 Generated with Claude Code
Summary by Sourcery
Update README to reflect the v1.0.0 production-stable release and current quality metrics.
Documentation: