ブランチの命名規則 / コミットメッセージの形式を定める - Githubissues

junohm410 / fjord-flea-market

A closed flea market app for FjordBootCamp members to easily buy and sell items within the community, featuring automated buyer selection and Discord notifications.

0 stars 0 forks source link

ブランチの命名規則 / コミットメッセージの形式を定める #21

Closed junohm410 closed 4 months ago

junohm410 commented 4 months ago

目的は以下の通り。

プロジェクト全体の可読性を向上させる
履歴の管理を容易にする

junohm410 commented 4 months ago

ブランチ名

prefix/description-in-kebab-case

prefix は以下の3種類を使用する。

新機能の追加：feature/{description}
バグ修正：bug/{description}
雑事（ユーザーに直接価値を生まない追加・修正）：chore/{description}

理由

多くのprefixやルールを用いると管理や選択が煩雑になりそうだから
FBCで使われるアプリになる予定なので、（ないかもしれないが）パッチを送っていただく際にFBCのチーム開発と同じルールを採用しておくと煩雑さを減らせるから

コミットメッセージ

定まったprefixなどは持たず、内容・whyを完結に書く
言語は基本的には日本語を使う
基本的には一行でまとめ、どうしても長くなりそうな場合は二行目空白・三行目に詳細を書く

理由

ブランチ名と同じ