juniors-best-practice について
初級開発者やチーム向けの、React と TypeScript の実践的な規約ガイドです。領域と優先度別のルールに誤例・正例があり、レビューやリファクタリング、新機能開発に活用できます。
主な機能
- 01優先度と領域別のルール
- 02React と TypeScript の指針
- 03フォーマット、インポート、Git の規約
- 04誤例と修正例
- 05個別ルールと統合ガイド
活用シーン
- 01React/TypeScript コードのレビュー
- 02初級開発者の指導
- 03保守しやすい形へのリファクタリング
- 04プロジェクト規約の統一
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ siberiacancode/ agent-skills --skill juniors-best-practiceインストール後、Claude Code で/juniors-best-practiceを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
AGENTS.mdmetadata.jsonREADME.mdrules/_sections.md_template.mdassets-svg-files.mdbeginner-const-vs-let.mdbeginner-double-negation.mdbeginner-early-return.mdbeginner-nullish-vs-or.mdbeginner-unnecessary-destructuring.mdbeginner-uppercase-constants.mdbeginner-useless-return-arrow.mddevtools-formatter-linter.mddevtools-package-manager-lock.mddevtools-sorting-imports.mdgit-commit-convention.mdreact-children-prop.mdreact-extends-component.mdreact-props-typing.mdreact-string-props.mdrest-naming-openapi.mdrest-scalability-abstractions.mdstyling-classnames-function.mdstyling-css-states.mdtypescript-alias-naming.mdtypescript-flat-translations.md詳細
ジュニア向けのベストプラクティス
React と TypeScript のプロジェクトにおける、ジュニア向けのベストプラクティスです。ルールは簡潔で実践的であり、コードレビューやリファクタリング、新機能の開発で一貫性を保てるよう、適用範囲ごとに整理されています。
適用するタイミング
次のような場合に、これらのガイドラインを参照してください。
- 明確さと一貫性を重視して React/TypeScript のコードを記述またはレビューするとき
- ジュニア開発者を指導するとき、またはチームの基本的な規約を定めるとき
- シンプルで保守しやすいパターンに沿うよう、コードをリファクタリングするとき
- プロジェクト全体の慣習(インポート、ツール、命名、コミット)を統一するとき
優先度別のルールカテゴリ
| 優先度 | カテゴリ | 影響 | プレフィックス |
|---|---|---|---|
| 1 | 初心者向けの基礎 | HIGH | beginner- |
| 2 | TypeScript | MEDIUM | typescript- |
| 3 | React | MEDIUM | react- |
| 4 | スタイリング | MEDIUM | styling- |
| 5 | 開発ツール | MEDIUM | devtools- |
| 6 | アセット | LOW-MEDIUM | assets- |
| 7 | Git | LOW | git- |
| 8 | REST | MEDIUM | rest- |
クイックリファレンス
1. 初心者向けの基礎(HIGH)
beginner-early-return- ネストを減らすため、早期リターンを優先するbeginner-double-negation-!isNotXパターンを避けるbeginner-unnecessary-destructuring- 明確さを保つため、オブジェクトをそのまま扱うbeginner-const-vs-let- 原則として const を使うbeginner-nullish-vs-or- デフォルト値には ?? を使うbeginner-useless-return-arrow- 不要な return を削除するbeginner-uppercase-constants- 変化しない定数にのみ UPPER_CASE を使う
2. TypeScript(MEDIUM)
typescript-alias-naming- 安全なパスエイリアスのプレフィックスを使うtypescript-flat-translations- 重複を減らすため、フラットな翻訳キーを優先する
3. React(MEDIUM)
react-string-props- 可能な場合は文字列リテラルを使うreact-children-prop- コンポジションには children を使うreact-extends-component- ネイティブ要素の props を拡張するreact-props-typing- props の型定義を読みやすく保つ
4. スタイリング(MEDIUM)
styling-classnames-function- 条件付きクラスには clsx を使うstyling-css-states- コンポーネントの状態には CSS セレクターを優先する
5. 開発ツール(MEDIUM)
devtools-formatter-linter- フォーマッターとリンターを使うdevtools-sorting-imports- インポートの順序とグループ分けを保つdevtools-package-manager-lock- パッケージマネージャーは 1 つに統一する
6. アセット(LOW-MEDIUM)
assets-svg-files- SVG はコンポーネントとして使う
7. Git(LOW)
git-commit-convention- 一貫したコミット規約を使う
8. REST(MEDIUM)
rest-scalability-abstractions- 再利用可能なトランスポート抽象化を基盤に REST レイヤーを構築するrest-naming-openapi- REST の命名を OpenAPI の契約に合わせる
使い方
詳しい説明と例については、各ルールのファイルを読んでください。
rules/beginner-early-return.md
rules/react-props-typing.md
各ルールのファイルには、次の内容が含まれています。
- 重要な理由についての簡単な説明
- 誤ったコード例とその説明
- 正しいコード例とその説明
- 補足情報と参考資料
ルールをすべてまとめたドキュメント
すべてのルールを展開した完全なガイドについては、AGENTS.md を参照してください。
コメント
Markdown 対応