読み方のヒント
矢印ボタン(または ← → キー)でページを移動できます。
決まりを、リポジトリの中の文書にまとめます。
README.md … アプリの説明と、動かし方
CONTRIBUTING.md … 変更の出し方(ブランチ・コミット・プルリクエスト)
docs/
architecture.md … フォルダ構成と依存の向き
decisions/ … 決めたことの記録(0001-...md)
review.md … レビューの観点
.github/
pull_request_template.md … プルリクエストの説明の型
workflows/ci.yml … CI
eslint.config.mjs、.prettierrc.json … 機械で確かめる決まり
README.md には、新しく加わった人が最初の日にすることを、手順で書きます。
## はじめに
1. Node.js 22 以降を入れる
2. `npm ci` でパッケージを入れる
3. `.env.example` を `.env.local` に写し、値を担当者から受け取る
4. `npm run dev` で動かし、http://localhost:3000 を開く
5. `npm run lint`・`npm run typecheck`・`npm run test:run` が通ることを確かめる
| 文書 | 読む人と時期 |
|---|---|
README.md | 加わった最初の日 |
CONTRIBUTING.md | 最初の変更を出す前 |
docs/architecture.md | ファイルの置き場に迷ったとき |
docs/review.md | レビューするとき、されるとき |
15 / 17