不具合修正に関する追記 #1469
Merged
不具合修正に関する追記 #1469
Conversation
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
✅ Deploy Preview for smarthr-design-system ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
hebikox
reviewed
Dec 25, 2024
src/content/articles/products/contents/release-note/releasenotes.mdx
Outdated
Show resolved
Hide resolved
…es.mdx Co-authored-by: Yukako Yoneyama <[email protected]>
misatokondo
reviewed
Dec 26, 2024
src/content/articles/products/contents/release-note/releasenotes.mdx
Outdated
Show resolved
Hide resolved
| #### 良い例 | ||
| ##### 基本の書き方 | ||
| - バックグラウンド処理詳細画面に表示される一部のエラーにおいて、CSVファイルの行数が表示されない不具合を修正しました。 | ||
| - ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。 |
There was a problem hiding this comment.
本題からそれたコメントなのですが、そもそも「基本機能のデータ不整合」はあってはならない（かなり不安になる話）なのでは…という気持ちになりました。例としてはふさわしくない気がしたのですがいかがでしょうか。
There was a problem hiding this comment.
🦀すぎるので差し替えます！ありがとうございます！
…es.mdx Co-authored-by: kondo <[email protected]>
kawakichi-desu
commented
Dec 27, 2024
| #### 良い例 | ||
| ##### 基本の書き方 | ||
| - バックグラウンド処理詳細画面に表示される一部のエラーにおいて、CSVファイルの行数が表示されない不具合を修正しました。 | ||
| - ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。 |
There was a problem hiding this comment.
Suggested change
| - ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。 | |
| - 手続き画面に表示されるエラーメッセージに群市区符号／郡市区符号と誤った表記があったため、郡市区符号に修正しました。 |
@misatokondo こちらに差し替えます🙏
misatokondo
approved these changes
Jan 6, 2025
drivesketch
approved these changes
Jan 6, 2025
hebikox
approved these changes
Jan 7, 2025
nao-nakata
reviewed
Jan 7, 2025
| @@ -38,8 +38,7 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 | |||
|
|
|||
| ### 不具合修正 | |||
| 不具合の修正について記載します。 | |||
| どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。 | |||
|
|
|||
| どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。ただし、発生条件が複雑な場合かつ影響範囲が小さい場合などは、詳しく書かない判断をしても構いません。 | |||
There was a problem hiding this comment.
「補足：不具合修正は簡潔かつ具体的に書く」の見出しに記載している内容はここに書くのでも良いかも？と思いました。
理由：
- 「詳しく書かない判断をしても構いません。 」を読むと具体例が欲しくなるので、直後にあると良い
- この内容は「要素別の具体的な書き方」という見出しのテーマと逸れる
Suggested change
| どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。ただし、発生条件が複雑な場合かつ影響範囲が小さい場合などは、詳しく書かない判断をしても構いません。 | |
| どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。ただし、発生条件が複雑な場合かつ影響範囲が小さい場合などは、詳しく書かない判断をしても構いません。 | |
| #### 良い例 | |
| - バックグラウンド処理詳細画面に表示される一部のエラーにおいて、CSVファイルの行数が表示されない不具合を修正しました。 | |
| - ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。 | |
| ##### 発生条件が複雑な場合かつ影響範囲が小さい場合 | |
| 発生条件が複雑な場合かつ影響範囲が小さい場合、「正しく絞り込めないことがある」のように発生条件や影響範囲を抽象化して表現するのも良いでしょう。 | |
| - 源泉徴収票機能の検索が正しく絞り込めないことがある不具合を修正しました。 | |
| #### 悪い例 | |
| - CSVファイル関連の不具合1件を修正しました。 | |
| - 不具合1件を修正しました。 |
There was a problem hiding this comment.
@nao-nakata 🦀!! ありがとうございます。提案内容を反映しつつ、補足の文章も調整のうえ移動させてみたので再度ご確認をお願いします🙏
There was a problem hiding this comment.
@kawakichi-desu
ありがとうございます。良さそうです！
細かい点だけ1点コメントを入れています。
https://github.com/kufu/smarthr-design-system/pull/1469/files#r1905075356
nao-nakata
reviewed
Jan 7, 2025
src/content/articles/products/contents/release-note/releasenotes.mdx
Outdated
Show resolved
Hide resolved
…es.mdx Co-authored-by: nakata <[email protected]>
nao-nakata
approved these changes
Jan 7, 2025
|
|
kawakichi-desu
commented
Jan 7, 2025
src/content/articles/products/contents/release-note/releasenotes.mdx
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
課題・背景
チケットは起票していませんでした！🙏
UI文言・ガイドライン定例で相談していた件です。
:docbase: ガイドライン・UI文言レビュー会 2024-12-12
:codi-md: 不具合修正どれくらい具体的に書くねん
やったこと
やらなかったこと
迷ったこと
動作確認
追加部分のキャプチャ
がさっと追加したところ
一文程度の追記をしたところ