docs: add CONTRIBUTING.md, issue and PR templates#47
Merged
Conversation
Covers setup, the day-to-day commands, and how to run each sandbox — the parts a new contributor needs that AGENTS.md (written for the SPEC->TEST-> IMPLEMENT->RECONCILE workflow) doesn't cover. The bug report template asks for an SSCCE so reports arrive reproducible instead of descriptive.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Simpler than the checklist form — three short sections instead of a tickbox list.
Not a ban on using AI — a request to reason about what it wrote before asking a reviewer to.
This was referenced Jul 14, 2026
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.
Summary
CONTRIBUTING.md— setup (nvm/corepack/pnpm install), the day-to-day commands (test/lint/typecheck/build, filtered to one package or one test file), and how to run each substrate sandbox. Points toAGENTS.mdfor the actual contribution workflow rather than duplicating it..github/ISSUE_TEMPLATE/bug_report.md— asks for an SSCCE (Short, Self-Contained, Correct/Compilable Example) instead of a free-form description, so reports arrive reproducible..github/ISSUE_TEMPLATE/config.yml— keeps blank issues enabled, adds a Discussions link for non-bug questions..github/PULL_REQUEST_TEMPLATE.md— a 3-item checklist mirroringAGENTS.md's RECONCILE step (tests/lint/typecheck, cross-scope verification, changeset).Test plan
pnpm format:check/pnpm lint— clean