Skip to content
Mitsuru Mutaguchi edited this page Sep 13, 2022 · 2 revisions

このページの目的

リリースノート作成にかかる手間を減らすため、プルクエストのルールを定めます。
GitHubのリリースノート自動作成では、リリースノートがプルクエストから作成されます。
人の手をなるべく介さず、リリースノートを作成できるようにします。

master直プッシュはリリースノートに載らなくなるので避けてください。

わかりやすいタイトルを付ける

リリースノートに記載される文言は、プルリクエストのタイトルより生成されます。
ユーザーからして、どのような変更であるかわかりやすい文言にしてください。

簡潔に、わかりやすく。

Bad👎

Update: 解凍機能

❌ prefixはいらない(自動で分類される)
❌ アップデートされた内容がよくわからない
❌ どこの画面?機能?なのか特定できない

Good👍

[キャビネット]ZIPファイルを解凍してアップロードする機能を追加しました

🔵 ですます調
🔵 どこのプラグインかわかる
🔵 どういう機能追加かわかる
🔵 先頭にプラグイン名や、管理機能名を[]付で記述する

ラベルを付ける

リリースノートの分類は、プルリクエストのラベルによって行われます。
プルリクエスト作成時には、必ずラベルを設定してください。

ラベルはプルリクエストの右カラムにはLabelsから選択できます。
ラベルの選び方は以下を参考に決めてください。
迷ったときは、有識者で相談しましょう。

機能を追加した

プラグインの追加、機能の追加、項目の追加等を行った

タグ : new feature

機能を改善した

ユーザがより使いやすくするため、既存の機能を変更した

タグ : enhancement

互換性のない変更を行った

機能を廃止する、項目を削除する等、後方互換の無い変更を行った
PHP7から8への移行対応を行った

タグ : breaking change

不具合を修正した

正常に機能しない箇所を修正した

タグ : bug

開発に関わる内容を修正した

プラグイン開発で利用するコアの関数を直した
Dockerの設定を直した
開発者向けに通知したい情報

タグ : developer update

リリースノートに載せたくない

リファクタリングなど、ユーザーにとって関係ない変更を行った
機能一覧に載せていない隠し機能を変更した

タグ : ignore for release

プルリクエストで行わないこと

脆弱性対応は非公開で行う必要があるため、プルリクエストは作成しないでください。

GitHubのセキュリティアドバイザリ機能を用いて、脆弱性対応を行ってください。

リポジトリの GitHub セキュリティ アドバイザリについて - GitHub Docs

参考資料

Clone this wiki locally