k6 Documentation

Document or review k6 features across three repositories: k6-DefinitelyTyped (TypeScript types), k6-docs (user documentation), and k6 (release notes).

Workflow

Pick the workflow that matches the user's intent:

Write documentation: follow references/workflows/write.md
Review documentation: follow references/workflows/review.md

Quick References

Critical Rules

Never push automatically - always ask first
Never chain commands with && or ; - run each command separately (prevents failures)
Only document user-facing features - not internal implementation
Use 1. for every numbered list item (not 1., 2., 3.)
Test every code example against k6@master before committing
No Co-Authored-By: Claude or AI attribution in commits

Validating examples (always run before committing)

Every code example in k6 documentation and release notes must execute cleanly against k6@master. The minimum loop:

# 1. cd into the k6 repo (not k6-docs or k6-DefinitelyTyped)
cd ~/path/to/k6

# 2. Make sure you're on master at the latest commit (the contract is k6@master)
git checkout master
git pull

# 3. Run each example as a separate command (no &&)
go run . run /path/to/script.js

If the run fails: read the error, fix the example in the source (doc or release note), re-run. Do not commit a change whose example doesn't run clean against current master. For the full multi-example workflow with parallel subagents, see references/testing-workflow.md.