Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CHANGELOG.md & write v4 current change log #85

Merged
merged 3 commits into from
Sep 7, 2023

Conversation

sksat
Copy link
Member

@sksat sksat commented Sep 6, 2023

概要

CHANGELOG.md を作った

Issue

@sksat sksat added documentation Improvements or additions to documentation enhancement New feature or request priority::high priorityg high tools labels Sep 6, 2023
@sksat sksat self-assigned this Sep 6, 2023
@meltingrabbit
Copy link
Member

質問

  1. CHANGELOG.md は,README.md や LICENCE のように,github 上で特別な意味を持つファイルですか?
  2. release note との区別はどうしますか?
  3. どのように運用しますか?(CHANGELOG.md の執筆タイミング.大きなPRのたびに書く?)

そもそも論で申し訳ないんだけどちょっと気になった.

@sksat
Copy link
Member Author

sksat commented Sep 7, 2023

  1. いいえ
  2. release note(というか,GitHub Releases についでに書いている文)は GitHub(not Git)だけにある情報なので,CHANGELOG.md の方を master としたい.なので,CHANGELOG.md に書いた内容をコピってそれに auto-generated なやつを足したやつ,とかを release note とするようなことを考えている(が,やってみながら考えるのがいいかな).
  3. そもそも現状ではこれに相当する情報がほぼ無なので,あればあるだけよい.あと,毎 PR で書かせると書くのも読むのもダルくなるだけだし,「大きな PR」でも大きさの判断が不明瞭.なので,特に強制はせず,書きたい・書くべきと contributor/reviewer が思った時に書く,ぐらいでよいと思う.雑な基準というかモチベーションとしては C2A user に対してなんらかのお知らせをしたくなったらできるだけ書いてほしい(ex: PR description だけ見てもいち C2A user には伝わりにくいだろうなという部分の補足,特定のスクリプトを実行してほしい,breaking change の影響範囲).

@meltingrabbit
Copy link
Member

CHANGELOG.md の方を master としたい.なので,CHANGELOG.md に書いた内容をコピってそれに auto-generated なやつを足したやつ,とかを release note とするようなことを考えている

なるほど,よさそう

@meltingrabbit
Copy link
Member

そもそも現状ではこれに相当する情報がほぼ無なので,あればあるだけよい.

気持ち把握.
userにとって「これがすべて」と思われるとちょっと嫌なので,なんか明記したい(この changelog は完全なものではありません,的な但し書き?)気持ちがあるな

@meltingrabbit
Copy link
Member

内容は良さそう

@sksat
Copy link
Member Author

sksat commented Sep 7, 2023

@meltingrabbit 注意書き追加しました

CHANGELOG.md Outdated Show resolved Hide resolved
@sksat sksat merged commit fc5702a into develop Sep 7, 2023
33 checks passed
@sksat sksat deleted the feature/add-changelog branch September 7, 2023 12:26
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 enhancement New feature or request priority::high priorityg high tools
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

CHANGELOG ほしい
2 participants