docs: baseline open-source hygiene (CONTRIBUTING, SECURITY, templates, English README)#29
Merged
Merged
Conversation
…s, English README
Repo had the fundamentals (LICENSE, .env.example, Dockerfile, CI) but was
missing the standard contributor-facing artifacts. Adds:
- CONTRIBUTING.md — install, the three CI checks, architecture red lines,
plugin-authoring template, commit/PR conventions (incl. the multi-close
Closes-keyword gotcha we already hit).
- SECURITY.md — private-advisory channel, in-scope vs out-of-scope, and
hardening notes for self-hosters.
- .github/ISSUE_TEMPLATE/{bug_report,feature_request}.md and
PULL_REQUEST_TEMPLATE.md — keep issues/PRs on-format.
- README.en.md — full English translation so non-Chinese readers aren't
bounced at the title. README.md gets a cross-link at the top plus a
contributing/security pointer at the bottom.
Housekeeping: moves INITIAL_PROMPT.md (v0 kickoff doc, long diverged from
current code) to docs/history/ so newcomers don't mistake it for ground truth.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Audit for open-source readiness flagged the standard contributor-facing files as missing. Repo already had the fundamentals (LICENSE,
.env.example,Dockerfile, CI,CLAUDE.md), but:CONTRIBUTING.mddocumenting the three CI checks, the core-doesn't-import-plugins red line, or the commit/PR conventions — leaving them to reverse-engineer intent from git history.INITIAL_PROMPT.mdat repo root is a v0 kickoff doc long-diverged from current code, actively misleading as "what the project is now."What changed
CONTRIBUTING.md— install + three CI checks (`lint` / `typecheck` / `format:check`), architecture red lines, plugin-authoring template, commit/PR conventions (including the `Closes [ux] Progress log does not auto-scroll to bottom #1 [ux] Show relative path + copy/download action instead of absolute file path #2` multi-close gotcha we hit earlier today).SECURITY.md— private advisory via GitHub Security tab, in-scope (SSRF through image fetching, prompt injection → server-side effects, credential exposure, DoS via expensive external calls), out-of-scope, and hardening notes for self-hosters..github/ISSUE_TEMPLATE/bug_report.md+feature_request.md+PULL_REQUEST_TEMPLATE.md— keep issues/PRs on format; PR template steers authors through the three CI checks and the multi-`Closes` pattern.README.en.md— full English translation. `README.md` gets a cross-link at top + contributing/security pointer at bottom.How this was verified
Linked issues
None — proactive hygiene, not closing any tracked issue.
Notes for the reviewer
🤖 Generated with Claude Code