-
Notifications
You must be signed in to change notification settings - Fork 128
docs: Keep a Changelog形式のchangelogを追加する #1109
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
Conversation
0.14.0
→0.15.0-preview.3
→0.16.1
(予定)のchangelog0.14.0
→0.15.0-preview.3
→main
のchangelogを書く
0.14.0
→0.15.0-preview.3
→main
のchangelogを書く0.14.0
→0.15.0-preview.3
→Unreleased
のchangelogを書く
0.14.0
→0.15.0-preview.3
→Unreleased
のchangelogを書く0.14.0
→0.15.0-preview.3
→"Unreleased"のchangelogを書く
|
検査したい事項はいくつか思い浮かびはするのですが、既製品ツールでは手が届かなさそうなのでMarkdownをパースするところから考えることになりそうです。 既製品ツールで検査できる範囲としてはデッドリンク検出がありそうですが、リポジトリ全体で行った方がよさそうに思えます。 [追記] やるとしたら、"Unreleased"部分を一発で抜き出したりするようなやつをcrates/xtaskに作るときについでにバリデートする、みたいになるかなと思ってます。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!!
お疲れ様でした!!
PRのタイトルはこれで合ってますかね?
(なんでこの3つになってて、かつ矢印が何を意味するのかわからなかったので。その3つしか書かれてない?)
changelogの書き方ドキュメント良いですねぇ。どんどんこういうの作っていきたい。
あとは何か気付けばというので @sevenc-nanashi さんもちょっと見ていただければという感じ…
だけどお忙しそうかもなので、先にマージでも良いかも?お任せします!🙏
0.14.0
→0.15.0-preview.3
→"Unreleased"のchangelogを書く
ちょっとhowに寄りすぎていると自分でも思っていたので、 #704 に寄せた題名にしてみました。 |
|
837ea3b
to
a1d9203
Compare
a1d9203
to
00b2a7d
Compare
|
内容
Keep a Changelogに従ったchangelogと、その方針のメモを追加する。
0.14.0
→0.15.0-preview.3
→0.16.0-preview.1
→0.16.0
→0.16.1
(予定)の流れを書く。0.14.0
→0.14.1
→0.15.6
の経路は書かない。多くのユーザーの助けになるであろう、
0.15.0-preview.16
→0.16.0
→0.16.1
(予定)の変化点に注力する。docs/guide/dev/changelog.mdには書かなかった判断メモ:
関連 Issue
Resolves: #704
その他
レンダリングされたやつ: