From efbb545a3d81cb7d7b8595ea8523a1cb11d8efd2 Mon Sep 17 00:00:00 2001 From: Arye Kogan Date: Wed, 18 Feb 2026 22:07:49 +0200 Subject: [PATCH 1/2] chore: improve OSS adoption and update package author - 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 --- README.md | 30 ++++++++++++++++++++++++++++++ pyproject.toml | 4 ++-- 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 33f4f84..82af93d 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,12 @@ Sync roadmap plans (epics, stories, tasks) to GitHub Issues and Projects v2. > **⭐ If planpilot helps you manage your roadmaps, consider [giving it a star](https://github.com/aryeko/planpilot)!** +## Why planpilot? + +Managing roadmaps through GitHub's UI works for small projects, but breaks down fast: manually creating dozens of issues, linking parent/child hierarchies, setting up blocked-by dependencies, and keeping project board fields in sync is tedious and error-prone. Scripting the GitHub API directly means dealing with pagination, rate limits, idempotency, and GraphQL complexity. + +**planpilot treats your roadmap as code.** Define epics, stories, and tasks in JSON files, commit them alongside your source code, and let planpilot handle the rest — creating issues, wiring up sub-issue hierarchies, setting blocked-by relations, and populating project board fields. It's idempotent (safe to rerun), supports dry-run previews, and works across multiple epics in a single run. + ## What it does **planpilot** takes structured plan files and turns them into a fully linked project board: @@ -86,6 +92,29 @@ poetry install +## Try it now + +See planpilot in action without any configuration or GitHub token — the built-in example runs a fully offline dry-run: + +```bash +git clone https://github.com/aryeko/planpilot.git && cd planpilot +pipx install . # or: pip install . +planpilot sync --config examples/planpilot.json --dry-run +``` + +```text +planpilot - sync complete (dry-run) + + Plan ID: 3832d3ffce22 + Target: example-org/example-repo + Board: https://github.com/orgs/example-org/projects/1 + + Items: 6 total (1 epic, 2 stories, 3 tasks) + Created: 6 (1 epic, 2 stories, 3 tasks) + + [dry-run] No changes were made +``` + ## Install Agent Skill ### Agent Self-Install @@ -241,6 +270,7 @@ A complete working example is in the [examples/](examples/) directory, including - Operations: - [E2E Testing](docs/testing/e2e.md) - [Release Guide](RELEASE.md) + - [Changelog](CHANGELOG.md) ## Support diff --git a/pyproject.toml b/pyproject.toml index c6d4138..2688afe 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,8 +4,8 @@ version = "2.3.0" description = "Sync roadmap plans (epics, stories, tasks) to GitHub Issues and Projects v2" readme = "README.md" license = "MIT" -authors = ["aryeko"] -maintainers = ["aryeko"] +authors = ["Arye Kogan"] +maintainers = ["Arye Kogan"] homepage = "https://github.com/aryeko/planpilot" repository = "https://github.com/aryeko/planpilot" documentation = "https://github.com/aryeko/planpilot/tree/main/docs" From 34600149645195e618896ba77144ca374e1acb97 Mon Sep 17 00:00:00 2001 From: Arye Kogan Date: Wed, 18 Feb 2026 22:21:38 +0200 Subject: [PATCH 2/2] fix: add missing sync map line to README dry-run output Co-Authored-By: Claude Opus 4.6 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 82af93d..9352120 100644 --- a/README.md +++ b/README.md @@ -112,6 +112,8 @@ planpilot - sync complete (dry-run) Items: 6 total (1 epic, 2 stories, 3 tasks) Created: 6 (1 epic, 2 stories, 3 tasks) + Sync map: examples/sync-map-sample.json.dry-run + [dry-run] No changes were made ```