docs: add CONTRIBUTING guide and issue/PR templates - #2
Merged
Conversation
No formal contributor entry point existed. Add a lightweight CONTRIBUTING.md that points to AGENTS.md (the real dev guide) without duplicating it, plus bug-report / feature-request issue templates, an issue-template config linking the dev docs, and a PR checklist. Link both READMEs (en + zh) to it. Co-Authored-By: Claude Opus 4.8 (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
The repo had no formal contributor entry point — no
CONTRIBUTING.md, no issue/PR templates. New contributors couldn't see how to set up, what checks to run, or the house rules (the real guide,AGENTS.md, is great but not linked from anywhere obvious).What
Lightweight, no duplication of
AGENTS.md:CONTRIBUTING.md— short version: dev setup (Bun), the three CI checks (typecheck/test/build), the house rules (CLI calls no LLM, framework ≠ library, external tools injectable + offline-tested, evidence-bound output), commit/PR conventions. Points toAGENTS.mdas the source of truth..github/ISSUE_TEMPLATE/bug_report.md— captures source kind (blog/YouTube/repo/PDF), command, adapter, tool versions..github/ISSUE_TEMPLATE/feature_request.md— nudges toward the right layer (ingest / adapter / recipe / CLI)..github/ISSUE_TEMPLATE/config.yml— contact links to AGENTS.md and docs/..github/PULL_REQUEST_TEMPLATE.md— checklist mirroring CI + the no-LLM / injectable-tools invariants.Docs/templates only — no code changes.
🤖 Generated with Claude Code