Skip to content

ROADMAP.md

Latest commit

 

History

History
137 lines (106 loc) · 5.21 KB

ROADMAP.md

File metadata and controls

137 lines (106 loc) · 5.21 KB
Raw

Roadmap

This roadmap is ordered by product value, not by feature novelty.

v0.1 — Core workflow (current)

Goal:

  • prove the core packaging workflow

Scope:

  • gitpack plan
  • gitpack apply
  • gitpack pr
  • file-level grouping
  • Nebius-backed AI suggestions enabled by default
  • commit rationale
  • risk warnings
  • markdown and JSON output

Success means:

  • a developer can run one command and get a sensible packaging plan
  • the write path is safe and understandable
  • the PR draft is useful with Nebius AI enabled by default
  • the CLI still works when AI is disabled or unavailable

v0.2 — Output quality

Goal:

  • make the planner produce output a developer would actually trust

Scope:

  • fix commit title generation: use actual file names and smarter type inference
  • add AI enhancement to gitpack plan (currently only apply and pr use it)
  • send diff content to AI, not just file paths
  • make plan include committed branch changes, not only working tree
  • interactive confirmation prompt in apply (TTY) instead of requiring --yes
  • colored terminal output; respects NO_COLOR and non-TTY
  • progress spinner on stderr during AI calls
  • gitpack doctor command
  • fix type definitions: move AiStatus to types.ts, add suggestionSource to CommitProposal

Success means:

  • commit titles reference actual behavior, not generic area labels
  • a developer mid-branch with existing commits gets a useful plan
  • the AI spinner eliminates the "is it frozen?" problem

v0.3 — View layer

Goal:

  • let developers track review progress without opening GitHub

Scope:

  • gitpack status: branch dashboard showing local changes, commits, PR status, review status, CI results
  • gitpack view diff: colored branch diff, skips noise files, supports --file and --commit
  • gitpack view comments: PR review comments grouped by file, with --unresolved filter
  • gitpack view checks: CI job breakdown, surfaces first failure line, prints rerun command
  • gitpack view log: commits with file stats and risk flags
  • all view commands degrade gracefully when gh is not installed

Success means:

  • a developer does not need to open GitHub to know: what CI job failed, who requested changes, and what the unresolved comments say
  • gitpack status --watch replaces refreshing the browser while CI runs

v0.4 — Handoff and release

Goal:

  • complete the workflow from packaging to published PR and release

Scope:

  • gitpack publish: push branch, generate PR body, call gh pr create --draft, print URL
  • gitpack release: group commits by type, generate release notes, support --draft and --publish
  • gitpack config: persistent user- and project-level settings
  • PR template detection: use .github/PULL_REQUEST_TEMPLATE.md when present
  • smarter --base detection via gh repo view and git remote show origin

Success means:

  • dirty branch → packaged commits → GitHub draft PR in four commands
  • gitpack release produces notes a maintainer would publish without heavy editing

v0.5 — Planner intelligence

Goal:

  • make the planner repo-aware rather than pattern-only

Scope:

  • related file pairing: keep foo.ts + foo.test.ts in the same commit group
  • repo convention learning: infer commit type and scope patterns from recent history
  • CODEOWNERS awareness: map changed files to owners, surface in PR risks
  • improved area classifier: recognize auth, api, db, components, hooks, services and more
  • change-risk scoring by diff shape (large deletions, many files, cross-area coupling)

Success means:

  • plans for real-world repos no longer split test files from the source files they test
  • commit type and scope naming matches the repo's own conventions
  • the PR draft flags which teams need to review based on ownership

v0.6 — Hunk-level splitting

Goal:

  • handle the hardest part of Git cleanup: one file, multiple logical changes

Scope:

  • gitpack split <file>: propose hunk groups within a single file
  • partial-file commit support using git add -p compatible patches
  • gitpack undo: reverse the last apply via saved pre-apply ref

Success means:

  • a developer with a 200-line diff in one file can split it into two reviewable commits
  • gitpack undo makes apply safe enough to run without hesitation

v1.0 — Broad everyday use

Goal:

  • make gitpack reliable enough for any developer on any repo

Scope:

  • stable command contract with no breaking changes after this point
  • polished docs and quick-start guide
  • fixture-based tests against multiple repo types (monorepo, library, service, config-only)
  • contributor guide and clear extension points
  • OpenAI-compatible provider adapter (alternative to Nebius)
  • local model support

Success means:

  • developers can adopt it with zero custom setup
  • contributors know exactly where to add new grouping rules, commands, or AI providers

Non-Goals

  • automatic push after commit creation (user must always confirm)
  • hidden destructive behavior of any kind
  • mandatory cloud AI
  • mandatory GitHub CLI dependency
  • a full GitHub client — gitpack surfaces the decisions a developer needs to make, not everything GitHub exposes
  • replying to review comments from the terminal (read-only view is the goal)
  • a TUI before the core CLI output is solid
  • issue or ticket auto-linking