表記揺れを防ぐため以下の点に注意してください。
- 必ず半角英数字を用いる
- かっこは半角
()
を用いる - 前には必ず半角スペースを挿入
- 後ろに文があれば後ろにも半角スペースを挿入
改定・施行日に合わせたブランチをyyyy-mm-dd
という名前でmain
から作成する。
例: 改定・施行日が2024年4月2日の場合→2024-04-02
1.で作成したブランチに移動し、改定内容を入力する。 総会での決議ごとにコミットを分けることが望ましい。
誤字脱字と表記規則に関するチェックを行う。
Warning
特に全角の()
や全角スペース、全角英数字の混入に注意すること。
気が向いたらGitHub Actionsでのチェックを導入する。
main
ブランチへ向けてPull Requestを作成する。
マージ規則については、2024年4月時点では検討中である。
改定内容がmain
にマージされたらTagを切ってReleaseを作成する。
まずReleasesページへ移動し、上部のDraft a New Release
をクリック。
次にChoose a tag
をクリックして、新しいタグ名を入力することで改定・施行日に合わせたタグを作成する。
ただし、タグ命名規則にはyyyy.mm.dd
を採用する。
例: 改定・施行日が2024年4月2日の場合→2024.04.02
Caution
ブランチ命名規則と異なることに注意。
その後、
Target: main
Previous tag: auto
であることを確認したらGenerate release notes
をクリックしてリリースノートを生成する。
この時点で下の写真のように
- Release Nameが自動的に
yyyy.mm.dd
に設定される - Release NoteにChange Logが自動入力される
はずである。なお、Pull Requestをマージしたあとであればその記述も入力される。
Caution
もしリリースノートを生成した際に上のいずれかを満たしていなければ何らかの間違いがある。 必ず引き返すこと。
リリース名とリリースノートが正しいことを確認したら、下部のSet as the latest release
にチェックが入っていることを確認してPublish release
をクリックする。
あとはリポジトリトップに戻り、Releasesの部分に正しい改定日とLatest
が表示されていれば改定完了。