k6-docs

k6 ドキュメント

3 つのリポジトリにわたって k6 の機能を文書化またはレビューします。k6-DefinitelyTyped（TypeScript の型）、k6-docs（ユーザードキュメント）、k6（リリースノート）が対象です。

ワークフロー

ユーザーの意図に合ったワークフローを選択してください。

• ドキュメントを作成する： references/workflows/write.md に従ってください
• ドキュメントをレビューする： references/workflows/review.md に従ってください

クイックリファレンス

• リポジトリ構成と機能タイプの特定
• TypeScript のパターンとトラブルシューティング
• 並列サブエージェントを使ったテストのワークフロー
• agent-browser コマンドのリファレンス
• トラブルシューティングガイド

重要なルール

• 自動でプッシュしないでください。必ず事前に確認してください
• && や ; でコマンドを連結しないでください。各コマンドを個別に実行してください（失敗を防ぐため）
• ユーザー向けの機能だけを文書化してください。内部実装は対象外です
• 番号付きリストの項目にはすべて 1. を使用してください（1.、2.、3. ではありません）
• コミット前に、すべてのコード例を k6@master に対してテストしてください
• コミットに Co-Authored-By: Claude や AI による帰属表記を含めないでください

例の検証（コミット前に必ず実行）

k6 のドキュメントとリリースノートに含まれるすべてのコード例は、k6@master に対して問題なく実行できる必要があります。最低限の手順は次のとおりです。

# 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

実行に失敗した場合は、エラーを確認し、ソース（ドキュメントまたはリリースノート）の例を修正してから、再実行してください。現在の master で問題なく実行できない例を含む変更はコミットしないでください。並列サブエージェントを使った複数の例のワークフロー全体については、references/testing-workflow.md を参照してください。