プロジェクトへの貢献をご検討くださりありがとうございます 🙏
開発・編集に参加される場合は、本ドキュメントをお読みください 👀
新機能の提案、不具合や誤字・脱字の報告は、このリポジトリの Issues に記載してください。
重複を避けるため、既に存在している Issue がないか確認をおねがいします。また、複数の問題がある場合は、それぞれ個別に追加してください。
単純な誤字や小さな変更でも、プルリクエストは大歓迎です！
コントリビューター行動規範 に反する内容を含むプルリクエストは受け入れておりません。ご注意ください。
コミットメッセージの規約として Conventionaal Commits および @commitlint/config-conventional を採用しています。
許容されている型は以下のとおりです。
- feat - 新しい機能の追加。
- fix - 不具合の修正。（小さな変更は chore を使用）
- docs - ドキュメントの更新。
- perf - パフォーマンスの改善。
- refactor - リファクタリング。機能に変化のない修正。
- style - コードスタイルの変更。スペースやインデントの調整や Lint エラーの修正。
- build - ビルドに関連する変更。
- ci - CI に関連する変更。
- test - テストに関連する変更。
- revert - コミットの取り消し。
- chore - その他の変更。 typo の修正などの小さな変更。
このプロジェクトでは、 Visual Studio Code の使用を推奨しています。
また、以下のボタンから StackBlitz Codeflow を使用して開発や修正をすることも可能です。
推奨する拡張機能は .vscode/extensions.json に記載しておりますので、適宜インストールするなどの対応をおねがいいたします。
このプロジェクトでは、パッケージマネージャーに pnpm を採用しています。
npm や yarn を使用している場合は、ご変更ください。
Volta を使用している場合、このプロジェクトで使用している Node.js のバージョンへ自動的に切り替わる場合があります。
パッケージマネージャーの準備ができたら、以下の手順で環境構築を行ってください。
このプロジェクトでは、 ESLint および textlint でコードのリンティング、 Prettier でコードの整形を行っています。
これらは、 Git のコミット時に自動的に実行され、適用されます。ただし、 pnpm install を実行している場合に限ります。
プロジェクトによっては ESLint でコードの整形まで行っているものもありますが、このプロジェクトではそのような設定にはしておりません。