Skip to content

docs: add public roadmap and update contribution policy for feature PRs#3835

Merged
devinfoley merged 3 commits intopaperclipai:masterfrom
devinfoley:df/feature-contribution-policy-change
Apr 16, 2026
Merged

docs: add public roadmap and update contribution policy for feature PRs#3835
devinfoley merged 3 commits intopaperclipai:masterfrom
devinfoley:df/feature-contribution-policy-change

Conversation

@devinfoley
Copy link
Copy Markdown
Contributor

@devinfoley devinfoley commented Apr 16, 2026

Thinking Path

  • Paperclip orchestrates AI agents for zero-human companies
  • As the project grows, more contributors want to build features — which is great
  • Without a public roadmap or clear contribution guidance, contributors spend time on PRs that overlap with planned core work
  • This creates frustration on both sides when those PRs can't be merged
  • This PR publishes a roadmap, updates the contribution guide with a clear path for feature proposals, and reinforces the workflow in the PR template
  • The benefit is that contributors know exactly how to propose features and where to focus for the highest-impact contributions

What Changed

  • Added ROADMAP.md with expanded descriptions of all shipped and planned milestones, plus guidance on coordinating feature contributions
  • Added "Feature Contributions" section to CONTRIBUTING.md explaining how to propose features (check roadmap → discuss in #dev → consider the plugin system)
  • Updated .github/PULL_REQUEST_TEMPLATE.md with a callout linking to the roadmap and a new checklist item to check for overlap with planned work, while preserving the newer required Model Used section from master
  • Added Memory / Knowledge to the README roadmap preview and linked the preview to the full ROADMAP.md

Verification

  • Open ROADMAP.md on GitHub and confirm it renders correctly with all milestone sections
  • Read the new "Feature Contributions" section in CONTRIBUTING.md and verify all links resolve
  • Open a new PR and confirm the template shows the roadmap callout and the new checklist item
  • Verify README links to ROADMAP.md and the roadmap preview includes "Memory / Knowledge"
  • pnpm -r typecheck currently fails in packages/mcp-server because local modules such as @modelcontextprotocol/sdk, zod, and @paperclipai/shared cannot be resolved there
  • pnpm test:run currently fails in unrelated UI suites because localStorage.clear is not a function in src/components/IssuesList.test.tsx and src/pages/Routines.test.tsx
  • pnpm build currently fails for the same packages/mcp-server missing-module issue

Risks

  • Docs-only change — no runtime or behavioral impact
  • Contribution policy changes were written to be constructive and to offer clear alternative paths (plugins, coordination via #dev, reference implementations as feedback)

Model Used

  • OpenAI Codex local agent (GPT-5-based coding model; exact runtime model ID is not exposed in this environment)
  • Tool use enabled for shell, git, GitHub CLI, and patch application
  • Used to rebase the branch, resolve merge conflicts, update the PR metadata, and verify the repo state

Checklist

  • I have included a thinking path that traces from project context to this change
  • I have specified the model used (with version and capability details)
  • I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work
  • I have run tests locally and they pass
  • I have added or updated tests where applicable (N/A — docs only)
  • If this change affects the UI, I have included before/after screenshots (N/A — no UI changes)
  • I have updated relevant documentation to reflect my changes
  • I have considered and documented any risks above
  • I will address all Greptile and reviewer comments before requesting merge

@devinfoley devinfoley requested a review from cryppadotta as a code owner April 16, 2026 19:25
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 16, 2026

Greptile Summary

Docs-only PR that publishes a ROADMAP.md with expanded milestone descriptions, adds a "Feature Contributions" section to CONTRIBUTING.md clarifying the policy on uncoordinated feature PRs, updates the PR template with a roadmap callout and checklist item, and links the README roadmap preview to the new file. All referenced files (ROADMAP.md, PLUGIN_SPEC.md) exist and links within repository files resolve correctly.

Confidence Score: 5/5

Safe to merge — docs-only change with no runtime impact.

All findings are P2 style suggestions (duplicate phrasing and arrow-character inconsistency). No logic, correctness, or security concerns exist in a purely documentation PR.

No files require special attention.

Important Files Changed

Filename Overview
ROADMAP.md New file documenting all shipped (✅) and planned (⚪) milestones with expanded descriptions and contributor coordination guidance; all internal links resolve correctly.
CONTRIBUTING.md Adds "Feature Contributions" section with policy on uncoordinated feature PRs, plugin system pointer, and links to ROADMAP.md and PLUGIN_SPEC.md (both verified to exist); minor arrow-character inconsistency flagged.
.github/PULL_REQUEST_TEMPLATE.md Adds roadmap callout between Risks and Model Used sections and a new checklist item; minor duplicate "check the roadmap first" phrasing flagged.
README.md Renames "Memory & Knowledge" to "Memory / Knowledge" to match ROADMAP.md and adds a link to the full roadmap; straightforward and correct.
Prompt To Fix All With AI
This is a comment left during a code review.
Path: .github/PULL_REQUEST_TEMPLATE.md
Line: 41

Comment:
**Duplicate "check the roadmap first" phrasing**

The callout tells contributors to "check [`ROADMAP.md`] first" at the start and then repeats "check the roadmap first" at the end of the same sentence, making it feel redundant.

```suggestion
> For core feature work, check [`ROADMAP.md`](ROADMAP.md) and discuss it in `#dev` before opening the PR — feature PRs that overlap with planned core work may need to be redirected. See `CONTRIBUTING.md`.
```

How can I resolve this? If you propose a fix, please make it concise.

---

This is a comment left during a code review.
Path: CONTRIBUTING.md
Line: 63

Comment:
**Arrow character inconsistency**

The new section uses the ASCII `->` arrow, while the existing "Path 2" section above uses the Unicode `` character (`Discord → #dev channel`). Keeping them consistent avoids a small visual mismatch.

```suggestion
- Start the discussion in Discord → `#dev` before writing code
```

How can I resolve this? If you propose a fix, please make it concise.

Reviews (3): Last reviewed commit: "docs: align roadmap coverage with README..." | Re-trigger Greptile

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
Introduces CONTRIBUTING.md with the updated PR contribution policy,
adds ROADMAP.md outlining planned improvements, and updates the
PR template and README to reference the new contribution guidelines.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
@devinfoley devinfoley changed the title docs: add contribution policy and roadmap for new PR workflow docs: add public roadmap and update contribution policy for feature PRs Apr 16, 2026
@devinfoley devinfoley force-pushed the df/feature-contribution-policy-change branch from bc84fca to c5055d6 Compare April 16, 2026 19:31
@devinfoley
Copy link
Copy Markdown
Contributor Author

@greptile review

@devinfoley
Copy link
Copy Markdown
Contributor Author

@greptile review

@devinfoley devinfoley merged commit e458145 into paperclipai:master Apr 16, 2026
5 checks passed
quangthien27 added a commit to quangthien27/paperclip that referenced this pull request Apr 16, 2026
* commit 'e93e418cbf7997a29ff258d51d761572e69bda92': (65 commits)
  fix: add ssh client and jq to production image (paperclipai#3826)
  [codex] Fix Docker gh installation (paperclipai#3844)
  docs: add public roadmap and update contribution policy for feature PRs (paperclipai#3835)
  feat(claude-local): add Opus 4.7 to adapter model dropdown (paperclipai#3828)
  fix(heartbeat): add hermes_local to SESSIONED_LOCAL_ADAPTERS (paperclipai#3561)
  release: v2026.416.0 notes (paperclipai#3782)
  Sync/master post pap1497 followups 2026 04 15 (paperclipai#3779)
  [codex] improve issue and routine UI responsiveness (paperclipai#3744)
  fix: disable HTTP caching on run log endpoints (paperclipai#3724)
  [codex] harden heartbeat run summaries and recovery context (paperclipai#3742)
  [codex] fix worktree dev dependency ergonomics (paperclipai#3743)
  chore(ui): drop console.* and legal comments in production builds (paperclipai#3728)
  fix: proper cache headers for static assets and SPA fallback (paperclipai#3734)
  fix(a11y): remove maximum-scale and user-scalable=no from viewport (paperclipai#3726)
  fix: trust PAPERCLIP_PUBLIC_URL in board mutation guard (paperclipai#3731)
  [codex] harden authenticated routes and issue editor reliability (paperclipai#3741)
  feat(adapters): add capability flags to ServerAdapterModule (paperclipai#3540)
  fix: Anthropic subscription quota always shows 100% used (paperclipai#3589)
  fix(server): respect externally set PAPERCLIP_API_URL env var (paperclipai#3472)
  fix(routines): include cronExpression and timezone in list trigger response (paperclipai#3209)
  ...

# Conflicts:
#	Dockerfile
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