Skip to content

Comments

リリースの手順を明文化する#74

Merged
xirc merged 5 commits intomainfrom
docs-for-releasing
Oct 22, 2021
Merged

リリースの手順を明文化する#74
xirc merged 5 commits intomainfrom
docs-for-releasing

Conversation

@negokaz
Copy link
Contributor

@negokaz negokaz commented Oct 21, 2021

ドキュメントの構成

CONTRIBUTING.md を作成することを検討しましたが、RELEASING.md という別のドキュメントを作成することにしました。

CONTRIBUTING.md は主にコントリビューターに向けたガイドラインとして機能しますが、リリース作業はリポジトリのメンテナとして登録されている限定されたメンバーによって実施される作業です。
リリース手順についてコントリビューター全員が知る必要はないため、CONTRIBUTING.md に記載するのは適切ではないように思いました。
そのため、RELEASING.md という独立したドキュメントにリリース手順を記載することにしました。
RELEASING.md というファイル名は Akka を参考にしました: akka/RELEASING.md at main · akka/akka

CONTRIBUTING.md について

リポジトリのオーナーにとって、コントリビューションガイドラインとは、人々がどのようにコントリビュートするべきかを伝える方法です。

コントリビューターにとって、このガイドラインは、上手に構築されたプルリクエストの提出をしたり、有益な Issue をオープンすることの確認に役立ちます。

オーナーおよびコントリビューターの双方にとって、コントリビューションガイドラインは、プルリクエストや Issue のリジェクトや再提出の手間を未然に軽減するための有効な手段です。

リポジトリコントリビューターのためのガイドラインを定める - GitHub Docs

追加したドキュメント

  • RELEASING.md
    • GitHub 上で必要なリリース作業の全体像を示します
  • PR テンプレート: PULL_REQUEST_TEMPLATE/releasing.md
    • リリース作業の詳しいタスクリストを示します
    • このテンプレートの存在は RELEASING.md 内で言及しています

参考情報

@negokaz negokaz force-pushed the docs-for-releasing branch 2 times, most recently from 0c6e972 to 3f45e5a Compare October 21, 2021 09:40
@negokaz negokaz force-pushed the docs-for-releasing branch from 3f45e5a to fd8eea9 Compare October 21, 2021 09:44
@negokaz negokaz marked this pull request as ready for review October 21, 2021 09:58
@negokaz negokaz requested a review from xirc October 21, 2021 10:00
@xirc xirc added the documentation Improvements or additions to documentation label Oct 22, 2021
Copy link
Contributor

@xirc xirc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, Thanks 👍

Copy link
Contributor

@xirc xirc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@xirc xirc merged commit f653688 into main Oct 22, 2021
@xirc xirc deleted the docs-for-releasing branch October 22, 2021 02:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants