Skip to content

Latest commit

 

History

History
89 lines (49 loc) · 2.93 KB

README.md

File metadata and controls

89 lines (49 loc) · 2.93 KB

バーチャルライブ研究会 会則管理用リポジトリ

表記上の注意

表記揺れを防ぐため以下の点に注意してください。

英数字について

  • 必ず半角英数字を用いる

かっこについて

  • かっこは半角()を用いる
  • 前には必ず半角スペースを挿入
  • 後ろに文があれば後ろにも半角スペースを挿入

改定時の手順

1. ブランチの作成

改定・施行日に合わせたブランチをyyyy-mm-ddという名前でmainから作成する。

例: 改定・施行日が2024年4月2日の場合→2024-04-02

2. 改定内容の入力

1.で作成したブランチに移動し、改定内容を入力する。 総会での決議ごとにコミットを分けることが望ましい。

3. 誤字脱字および表記規則チェック

誤字脱字と表記規則に関するチェックを行う。

Warning

特に全角の()や全角スペース、全角英数字の混入に注意すること。

気が向いたらGitHub Actionsでのチェックを導入する。

4. Pull Requestを作成

mainブランチへ向けてPull Requestを作成する。

マージ規則については、2024年4月時点では検討中である。

5. Releaseを作成

改定内容が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

もしリリースノートを生成した際に上のいずれかを満たしていなければ何らかの間違いがある。 必ず引き返すこと。

Releasesが選択され、指定したタグからリリース名とリリースノートを正しく生成できている例


リリース名とリリースノートが正しいことを確認したら、下部のSet as the latest releaseにチェックが入っていることを確認してPublish releaseをクリックする。

あとはリポジトリトップに戻り、Releasesの部分に正しい改定日とLatestが表示されていれば改定完了。

alt text