Contributing
contextlint はオープンソースプロジェクトであり、ルール追加、バグ修正、ドキュメント改善などのコントリビュートを歓迎します。このカテゴリでは、contextlint の開発に参加するために必要なリポジトリのセットアップ、ルール追加の手順、テスト規約をまとめています。
このカテゴリの構成
Section titled “このカテゴリの構成”- 開発環境のセットアップ — bun workspace の構成と各 package の役割、ビルド・テスト・型チェックのコマンド
- 新しいルールの追加 — ID 採番から Zod schema、registry 登録、
schema.json更新までの手順 - テストの書き方 —
bun:testの使い方と CJK 言語のテストフィクスチャが必須である理由
コントリビュートの流れ
Section titled “コントリビュートの流れ”- リポジトリを fork して、1 つの Issue / 機能ごとに 1 つの branch を作る
- 開発環境のセットアップ に従ってローカルで動かす
- 変更内容に応じて、対応する page の規約に沿って実装・テスト・ドキュメント更新を行う
- Conventional Commits 形式(
feat:、fix:、docs:など)でコミットし、Pull Request を作成する
コード・コメント・ドキュメント・コミットメッセージはすべて英語で記述してください。GitHub 上の Issue / PR / レビューコメントも英語が標準です。