search

tuyuri6ka / dotfiles

0 stars 0 forks source link

【〆 2024/01】Task: Issue/PR テンプレートをアップデートする #13

Closed tuyuri6ka closed 4 months ago

tuyuri6ka commented 7 months ago

関連調査 issue（あれば）

特になし

背景（なるべく詳しく、他タイトルのシスに説明するように）

現在の Issue は少し古く、今仕事上で運用しているもののほうが性にあっていることがわかった。そのため、Issue/PR の Issue テンプレートを業務と同じように更新することとした。

実装方針

テンプレート

以下のような区分けで作る。

config.yaml

Issue テンプレートを作成する際、複数のテンプレートを使い分けることがあると思うが、その際には config.yaml を利用してやると使い分けが簡単にできるらしい。

補足

ドキュメントをしっかり書くことは思ったよりも開発速度の高速化に繋がります。 というのも、レビュー依頼側が一人でありレビュワーが複数人であると仮定すると、ドキュメントを書かないと一人が楽になるが複数人が負担となります。一方、ドキュメントをちゃんと書くと、一人はつらいが複数人は楽になるからです。 （あと何より、レビュワー側はそもそもの前提条件の把握に時間がとてもかかるので、レビュー依頼側が情報を事前に書いて渡す方が早い。）

tuyuri6ka commented 4 months ago

実装 PR をマージしたため Close します。