docs: add CONTRIBUTING.md - #416
Merged
Merged
Conversation
§10 claimed pre-commit hooks run ESLint, Prettier, and related tests, but .lintstagedrc only runs eslint --fix and prettier --write on staged files. Corrected the description accordingly.
ada-sen
marked this pull request as ready for review
September 26, 2026 03:01
- Document the ripgrep prerequisite; the ripgrep_search tests fail without rg. - Say how live suites are skipped: *.live.test.ts runs whenever ANTHROPIC_API_KEY is set; unset it to skip. - Scope the self-merge rule to contributor PRs. - Say the pre-commit hook only covers staged .ts/.tsx files, and that markdown/JSON/YAML changes need a manual format check.
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
2 participants
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.
Adds a
CONTRIBUTING.mdat the repo root covering:test, format:check, build)
tracking ticket
tests for bug fixes
// ABOUTME:headers, strict TypeScript, noconsole.log, pre-commit hooks) and a note that keeps commits/PR bodiesfree of internal details, since this repo is public
Drafted by our docs writer (Dex) and reviewed before submission. Checked
against current
main(package.json scripts/engines,.github/workflows/ci.yml,the
format:checkglob, the package list, anddocs/development.md/CLAUDE.md) so it reflects actual repo conventions rather than assumptions.PRI-3257
Review fixes (jc)
rg) as a prerequisite. CI installs it, and theripgrep_searchtests fail without it.*.live.test.tssuites runwhenever
ANTHROPIC_API_KEYis set;ANTHROPIC_API_KEY= npm testskips them.own).
.ts/.tsxfiles, somarkdown/JSON/YAML changes need a manual
npm run format:check.