不具合修正に関する追記 #1469
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -38,8 +38,7 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 | |||||
|
|
||||||
| ### 不具合修正 | ||||||
| 不具合の修正について記載します。 | ||||||
| どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。ただし、発生条件が複雑な場合かつ影響範囲が小さい場合などは、詳しく書かない判断をしても構いません。 | ||||||
| 不具合修正が複数ある場合は、箇条書きで記載します。 | ||||||
|
|
||||||
| ### 廃止した機能 | ||||||
|
|
@@ -161,3 +160,21 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 | |||||
|
|
||||||
| ##### 例 | ||||||
| UIのみの変更であり、検索結果や付与する権限については変更ありません。 | ||||||
|
|
||||||
| ### 補足：不具合修正は簡潔かつ具体的に書く | ||||||
| 基本姿勢は[不具合修正の基本的な書き方](#h3-3)に記載している「どの画面、どのUIでどのような不具合が修正されたかを具体的に書く」です。 | ||||||
| 一文で簡潔に書くことが多い不具合修正は、短文ゆえに、書き方によっては本来影響のないユーザーに不安を与えかねない内容になる場合があります。 | ||||||
| どの粒度で書くか、どのように書くか悩ましいときは、以下の例を参考にしてください。 | ||||||
kawakichi-desu marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| #### 良い例 | ||||||
| ##### 基本の書き方 | ||||||
| - バックグラウンド処理詳細画面に表示される一部のエラーにおいて、CSVファイルの行数が表示されない不具合を修正しました。 | ||||||
| - ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。 | ||||||
|
There was a problem hiding this comment. 本題からそれたコメントなのですが、そもそも「基本機能のデータ不整合」はあってはならない（かなり不安になる話）なのでは…という気持ちになりました。例としてはふさわしくない気がしたのですがいかがでしょうか。 There was a problem hiding this comment. 🦀すぎるので差し替えます！ありがとうございます！ There was a problem hiding this comment.
Suggested change
@misatokondo こちらに差し替えます🙏 |
||||||
|
|
||||||
| ##### 発生条件が複雑な場合かつ影響範囲が小さい場合 | ||||||
| - 源泉徴収票機能の検索が正しく絞り込めないことがある不具合を修正しました。 | ||||||
| - 発生条件や影響範囲を「正しく絞り込めないことがある」と表現しています。 | ||||||
|
|
||||||
| #### 悪い例 | ||||||
| - CSVファイル関連の不具合1件を修正しました。 | ||||||
| - 不具合1件を修正しました。 | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
「補足：不具合修正は簡潔かつ具体的に書く」の見出しに記載している内容はここに書くのでも良いかも？と思いました。
理由：
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.
@nao-nakata 🦀!! ありがとうございます。提案内容を反映しつつ、補足の文章も調整のうえ移動させてみたので再度ご確認をお願いします🙏
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.
@kawakichi-desu
ありがとうございます。良さそうです！
細かい点だけ1点コメントを入れています。
https://github.com/kufu/smarthr-design-system/pull/1469/files#r1905075356