10-recipe-app: A TypeScript repository from yoko-at-home

開発するにあたっての厳守する項目

パッケージマネージャーはyarn固定
CSSはTailwindのみを使用（もし再現できななどあればメンバーに相談）
記名関数ではなくアローファンクション固定
pageはexport defaultでcomponentはnamed exportを使用する
型の宣言にはtypeを使用する以下例：

# こちらは使わない
interface ButtonProps {
  foo: string;
}

# こちらを使う
type ButtonProps = {
  foo: string;
}

export const Button: FC<ButtonProps> = (props) => {
  省略
}

はじめに

環境構築は yarn で行う。 local で立ち上げる際は下記コード。

yarn dev

issue の作成

issue の頭に作業内容に沿ったタグをつけ、簡潔に分かりやすくタイトルを作成。

【FE】→ フロントエンド作業
【BE】→ バックエンド作業
【DOC】→ ドキュメンテーション周りの作業
【DEV】→ 環境構築系
【ETC】→ その他

例：【FE】カルーセルコンポーネントの作成

issue作成の流れ

Issuesタブから「New Issue」を押下し、遷移先で「Get started」を押下。

テンプレートに沿って内容の記入し自分が担当するタスクの場合は「assign yourself」を押下。担当が決まっていなければ何も選択しなくてよく、他の方を担当に設定する場合は歯車から設定。

Submit new issueを押下し、issueが作成されたらProjectに「10-recipe」を設定。
状況に合わせたStatusに変更する。
- IceBox（凍結タスク）
- Todo（将来的に着手するタスク）
- In Progress（現在着手中のタスク）
- Done（終了したタスク）

ブランチの命名規則

[開発するブランチの作成の仕方]

feature#xx-yourName(feature#issues 番号-作業者名)

[修正するブランチの作成の仕方]

fix#xx-yourName(feature#issues 番号-作業者名)

git pull --rebase origin develop
git checkout -b feature#{番号}-{名前}

コミットメッセージ

分かりやすければ OK で特に規則は無し。ただ、機能事にコミット分けると PR 作成時や revert する際に役に立つので意識する。

PR の作成方法

エイリアスの設定を忘れずに。

# タスク作業後
git add .
git commit -am "作業内容"
git checkout develop
git pull --rebase origin develop
git checkout {作業ブランチ}
git merge develop
# コンフリクト解消
git push -u origin {作業ブランチ}

上の作業後、Pull requests タブの Compare & request を押下

テンプレートに沿って内容の記入し、右カラムのAssigneesを自分に設定。「Create pull request」を押下後、チェック項目を確認し問題ない項目にチェックを入れる。

以下必要な場合のみ実行

もし作業中で他の方にレビュー依頼通知を飛ばしたくない場合はCreate pull request横の ▼ から「Create draft pull request」を選択

Review、merge の流れ

PR が作成されると Slack に通知がいくので気づいた人がレビューする。
Approve されるとマージできるようになる。
PR 作成者がマージする。

yoko-at-home/10-recipe-app