docs: add quick-reference command table to developer guide
Open
Beginner friendly
Nobody has claimed this yet.
area:documentation
beginner friendly
community
contributions-welcome
difficulty:beginner
difficulty:easy
enhancement
good first issue
help wanted
time:<15m
type:docs
up-for-grabs
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 7
- Avg merge
- 39m
- Merged PRs (30d)
- 39
Description
🎯 What needs to be done
Add a clean Markdown table summarizing all key local developer commands at the top of docs/DEVELOPMENT.md.
Why this matters
Developers frequently consult docs/DEVELOPMENT.md to find verification and test commands. A top-level summary table makes onboarding significantly faster.
📍 Where to work
docs/DEVELOPMENT.md
🧭 Implementation guidance
- Open
docs/DEVELOPMENT.md. - Add a table with columns:
Command,Description, andWhen to Runcovering:npm run devnpm run lintnpx tsc --noEmitnode scratch/run-tests.mjsnode scratch/secret-scan.mjsnpm run build
✅ Acceptance criteria
- Table is well-formatted and easy to scan.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open docs/DEVELOPMENT.md and review its existing structure before adding the quick-reference section at the top. Include the six listed commands with Command, Description, and When to Run columns; done means the Markdown table is well-formatted and easy to scan.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 92/100