Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.65 KB

File metadata and controls

30 lines (20 loc) · 1.65 KB

Contributing

Thank you for improving explorables. By participating, follow the CODE_OF_CONDUCT.md and licence your contribution under the repository terms.

Local setup

Use Node.js 22.22.2+ (22.x) or 24.15.0+ (24.x), with pnpm 10.26.0+ (10.x) or pnpm 11. Node.js 24 and pnpm 11 remain the default toolchain:

pnpm install --frozen-lockfile
pnpm check
pnpm site:build
pnpm course:build

Browser changes also require pnpm test:browser and pnpm site:test after installing Playwright Chromium. Keep unrelated changes out of a pull request.

Write Markdown prose as one source line per paragraph and let editors and renderers wrap it visually. Do not hard-wrap prose to a fixed column width; preserve intentional line breaks in code fences, tables, directives, and other structural blocks.

Useful contribution shapes

  • Runtime or validator fix with a regression test
  • Explorable calculation, interaction, or accessibility improvement
  • Focused exercise and deterministic tests
  • Lesson correction with a cited primary source where facts are unstable
  • Documentation, translation, or setup improvement

Course review checks accuracy, prediction/manipulation/implementation flow, text fallback, keyboard and narrow-pane use, intentional failure quality, licensing, and the tutor's protected paths. Explorable review additionally checks model tests, mount/unmount cleanup, structured events, CSP compatibility, and absence of network calls.

Do not add accounts, tracking, hosted execution, extra Markdown directives, a visual editor, or general LMS features. Discuss material format/security changes in an issue and record accepted departures from the PRD in an ADR.