Skip to content

Comments

chore: improve OSS adoption and update package author#86

Merged
aryeko merged 2 commits intomainfrom
chore/improve-oss-adoption
Feb 18, 2026
Merged

chore: improve OSS adoption and update package author#86
aryeko merged 2 commits intomainfrom
chore/improve-oss-adoption

Conversation

@aryeko
Copy link
Owner

@aryeko aryeko commented Feb 18, 2026

Summary

  • Add "Why planpilot?" positioning section to README
  • Add "Try it now" zero-config dry-run example so visitors see output in 10 seconds
  • Link CHANGELOG from README documentation section
  • Update PyPI author/maintainer from "aryeko" to "Arye Kogan"
  • Set repo homepage URL to PyPI page (via gh repo edit)

Test plan

  • poe docs-links passes
  • poe check passes (lint, format, typecheck, 509 tests at 98% coverage)

🤖 Generated with Claude Code

Summary by CodeRabbit

Release Notes

  • Documentation

    • Enhanced README with new "Why planpilot?" section detailing roadmap management benefits.
    • Added "Try it now" section with offline dry-run example and sample commands.
    • Added Changelog link reference.
  • Chores

    • Updated project metadata with full author and maintainer names.

- Add "Why planpilot?" section to README for positioning
- Add "Try it now" zero-config dry-run example to README
- Link CHANGELOG from README documentation section
- Change PyPI author/maintainer from "aryeko" to "Arye Kogan"

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Feb 18, 2026

Warning

Rate limit exceeded

@aryeko has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 2 minutes and 31 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

Documentation enhancements added to README.md covering roadmap management rationale and offline usage demonstration. Project metadata in pyproject.toml updated to reflect full author and maintainer names instead of usernames. No functional code changes.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md
Added "Why planpilot?" section explaining roadmap challenges and product approach. Added "Try it now" section with offline dry-run example including command syntax and expected output. Added Changelog link reference.
Project Metadata
pyproject.toml
Updated authors and maintainers fields from username ["aryeko"] to full name ["Arye Kogan"].

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A rabbit hops through docs so bright,
Names now full, metadata set right,
From "aryeko" to "Arye Kogan's" call,
Try offline now—our dry-run enthralls! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore: improve OSS adoption and update package author' directly matches the main changes in the PR (documentation improvements for OSS adoption and author metadata updates).
Description check ✅ Passed The PR description covers the key changes with a summary and test plan, but is missing the 'Verification', 'Breaking changes', and 'Notes' sections from the required template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/improve-oss-adoption

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Feb 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
pyproject.toml (1)

7-8: Consider adding an email address for complete PyPI metadata.

The [tool.poetry] authors/maintainers format conventionally follows "Name <email>". "Maintainers may contain an email and be in the form name <email>." Without an email, the PyPI author/maintainer contact field will be left blank on the package page.

✨ Optional: add email to author/maintainer fields
-authors = ["Arye Kogan"]
-maintainers = ["Arye Kogan"]
+authors = ["Arye Kogan <your@email.com>"]
+maintainers = ["Arye Kogan <your@email.com>"]
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@pyproject.toml` around lines 7 - 8, Update the [tool.poetry] metadata entries
so the authors and maintainers include an email address (e.g., change the
authors and maintainers values from "Arye Kogan" to the conventional "Arye Kogan
<your-email@example.com>") so PyPI will show contact info; modify the authors
and maintainers fields in pyproject.toml accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 95-116: Update the "Try it now" sample output block in README.md
to include the missing "Sync map: 
/absolute/path/to/examples/sync-map-sample.json.dry-run" line (as shown in
examples/dry-run-output.txt) immediately before the final "[dry-run] No changes
were made" message so the example output matches the actual command output in
the "Try it now" section's sample block.

---

Nitpick comments:
In `@pyproject.toml`:
- Around line 7-8: Update the [tool.poetry] metadata entries so the authors and
maintainers include an email address (e.g., change the authors and maintainers
values from "Arye Kogan" to the conventional "Arye Kogan
<your-email@example.com>") so PyPI will show contact info; modify the authors
and maintainers fields in pyproject.toml accordingly.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@aryeko aryeko merged commit d2017c7 into main Feb 18, 2026
13 checks passed
@aryeko aryeko deleted the chore/improve-oss-adoption branch February 18, 2026 20:56
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.

1 participant