Pull requests Rule - opensource-workshop/connect-cms GitHub Wiki
リリースノート作成にかかる手間を減らすため、プルクエストのルールを定めます。
GitHubのリリースノート自動作成では、リリースノートがプルクエストから作成されます。
人の手をなるべく介さず、リリースノートを作成できるようにします。
master直プッシュはリリースノートに載らなくなるので避けてください。
リリースノートに記載される文言は、プルリクエストのタイトルより生成されます。
ユーザーからして、どのような変更であるかわかりやすい文言にしてください。
簡潔に、わかりやすく。
Update: 解凍機能
❌ prefixはいらない（自動で分類される）
❌ アップデートされた内容がよくわからない
❌ どこの画面？機能？なのか特定できない
[キャビネット]ZIPファイルを解凍してアップロードする機能を追加しました
🔵 ですます調
🔵 どこのプラグインかわかる
🔵 どういう機能追加かわかる
🔵 先頭にプラグイン名や、管理機能名を[]付で記述する
リリースノートの分類は、プルリクエストのラベルによって行われます。
プルリクエスト作成時には、必ずラベルを設定してください。
ラベルはプルリクエストの右カラムにはLabelsから選択できます。
ラベルの選び方は以下を参考に決めてください。
迷ったときは、有識者で相談しましょう。
プラグインの追加、機能の追加、項目の追加等を行った
タグ : new feature
ユーザがより使いやすくするため、既存の機能を変更した
タグ : enhancement
機能を廃止する、項目を削除する等、後方互換の無い変更を行った
PHP7から8への移行対応を行った
タグ : breaking change
正常に機能しない箇所を修正した
タグ : bug
プラグイン開発で利用するコアの関数を直した
Dockerの設定を直した
開発者向けに通知したい情報
タグ : developer update
リファクタリングなど、ユーザーにとって関係ない変更を行った
機能一覧に載せていない隠し機能を変更した
タグ : ignore for release
脆弱性対応は非公開で行う必要があるため、プルリクエストは作成しないでください。
GitHubのセキュリティアドバイザリ機能を用いて、脆弱性対応を行ってください。