sakura-editor / changelog-sakura

changelog for sakura
MIT License
1 stars 3 forks source link

サクラエディタ本体のPR、Issueのラベル付け方法を明確にする #3

Closed takke closed 5 years ago

takke commented 5 years ago

github_changelog_generator で CHANGELOG.md を生成するために、サクラエディタ本体の PR や Issue のラベル付けをドキュメント化しておいたほうがいいと思います。

PR という意味では https://github.com/sakura-editor/sakura/wiki/11.SakuraEditor_PRGuide あたりかなと思いましたが、PR を送るときに私のような部外者はラベルを付けられないので、https://github.com/sakura-editor/sakura/wiki 配下にラベルの付け方を解説した別の記事があってもいいかと思います。既にあったらすみません。

KENCHjp commented 5 years ago

既にあったらすみません。

@takke さんいろいろとありがとうございます。 一応このプロジェクトまだ立ち上がったばかりなのでいろいろと準備することは多々あるかと思います。 一方あまりがちがちなルールも設けたくないのも正直なところなので、 「PRやIssueにつけたラベルによって、CHANGELOG.meの生成に影響がある」旨の記載および、 現時点で、何を除外(または含める)されるのかをどこかに明記しておくのは重要かと思います。 気が付いたときにプロジェクトメンバーがラベルをメンテするって感じで。 ここへ記載したルールで各々のPRがどっちかどうかって議論に発展してしまうのは避けたいかなと。 

KENCHjp commented 5 years ago

あと、何を加えて何を除外するかですが、あれどっかにかいたかもしれませんが、

enhancement bug を対象にするけれども、 management question refactoring Release は除外って感じかなと。 抽出されたものを見たのですが、まだつけ方結構甘いかったですね(笑)

takke commented 5 years ago

今のところのバッチファイルの設定では、

https://github.com/sakura-editor/changelog-sakura/pull/1/files#diff-3ea088be16b8edc4ebf1fa1d8626038fR10

set EXCLUDELABELS=duplicate,question,invalid,wontfix,CI,management,refactoring

のように除外しています。

そして、github_changelog_generator としては、「enhancement」「bug」ラベルをまとめ、「それ以外のIssue」「それ以外のPR」という分類をするようです。

KENCHjp commented 5 years ago

今のところのバッチファイルの設定では、

了解です。リリースのときに調整とラベルつけをそれなりにしっかりやらないとですね。 IssueはしかとでPRだけでいいかなっておもってますが。 (Issueは聞いただけで特にソースにコミットされてないものもあるかと思うので)

KENCHjp commented 5 years ago

specification change も拾わないとだめそうっすね。

takke commented 5 years ago

https://github.com/sakura-editor/sakura/wiki/CHANGELOG.md%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6 の wiki にまとめておきました。