Skip to content

docs: add CONTRIBUTORS.md issues-only policy (#1517)#1537

Open
cliffhall wants to merge 3 commits into
v2/mainfrom
chore/1517-contributors-md
Open

docs: add CONTRIBUTORS.md issues-only policy (#1517)#1537
cliffhall wants to merge 3 commits into
v2/mainfrom
chore/1517-contributors-md

Conversation

@cliffhall

Copy link
Copy Markdown
Member

Closes #1517.

Summary

Adds a root CONTRIBUTORS.md documenting the contribution policy: we accept issues, not pull requests. Maintainers handle design and implementation through the prompt-driven workflow described in AGENTS.md. Contributors who have already built a change locally are asked to share the prompt they used, not a diff.

The doc covers every requirement from the issue:

  • Policy statement — issues only; external PRs are not merged; maintainers own design/implementation.
  • How to report a bug / request a feature — open a well-scoped issue on the right version board, with a table mapping v2 / v1.5 / v1 to their boards, base branches, and labels (cross-referencing the "Label by version" convention in AGENTS.md).
  • If you've already fixed it locally — don't send a diff; share the prompt(s), before/after behavior, and how you verified.
  • What makes a good issue / prompt submission — reproduction or use case, expected vs. actual, affected client (Web / TUI / CLI), and exact prompt text.
  • Rationale — explains the prompt-driven workflow so the policy reads as intentional, with a welcoming tone.
  • Cross-reference — adds a "Contributing" section to AGENTS.md linking to CONTRIBUTORS.md. (There is no root README.md in this repo, so AGENTS.md is the cross-reference point — the issue allows "README.md and/or AGENTS.md".)

Notes

  • Docs-only change to root files; no client code is touched, so the build/test gates don't apply (no root-level prettier scope covers these files either).
  • The optional follow-up (a CONTRIBUTING.md redirect / PR template to steer would-be PR authors) is left for a separate issue if desired.

🤖 Generated with Claude Code

Document the contribution policy: we accept issues, not pull requests.
Maintainers handle design and implementation through a prompt-driven
workflow. Contributors who have already built a change locally should
share the prompt they used rather than a diff.

Cross-reference the policy from AGENTS.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@cliffhall cliffhall added the v2 Issues and PRs for v2 label Jun 27, 2026
cliffhall and others added 2 commits June 27, 2026 18:49
…icy (#1517)

GitHub auto-populates pull_request_template.md into every new PR body,
so it steers would-be external PR authors to CONTRIBUTORS.md before they
submit a diff.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The policy takes effect after v2/main merges into main, leaving a single
line of development. Tell contributors to open a well-formed issue rather
than routing them to per-version project boards.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

v2 Issues and PRs for v2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant