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.

Sign up for GitHub

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

Jump to bottom

CHANGELOG の句点ルールについて #292

Open

meltingrabbit opened this issue Jan 15, 2024 · 0 comments

Labels

Member

meltingrabbit commented Jan 15, 2024 •

edited

Loading

詳細

基本的なサマリーは，名詞句で書きたく，句点は不要
一方で， mignration guid は説明文であり，１名詞句では，情報が漏れることや，意図が伝わりにくいことが発生するので，文とすべきと考える．文なので句点をいれるべきなはず．
- すくなくとも体言止めではなく文章であれば，箇条書きでも句点をいれるのが一般的だが，（例外的に）短い文章の箇条書きは省略されることがあるだけ，という認識
- migration guid については，おおくはある程度の長さになる，または複文になることがしばしばあるので，句点をつけるのを基本としたい．

close条件

CHANGELOGを修正したら

備考

関連: #291

meltingrabbit mentioned this issue

Update version (v4.2.0) #287

Merged

meltingrabbit added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment