Skip to content

Commit

Permalink
おおまかに記載
Browse files Browse the repository at this point in the history
  • Loading branch information
ken7253 committed Dec 8, 2024
1 parent 765ee4e commit 140c20b
Show file tree
Hide file tree
Showing 4 changed files with 127 additions and 2 deletions.
Binary file added review-comment/public/image/label.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added review-comment/public/image/review.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
111 changes: 109 additions & 2 deletions review-comment/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,119 @@ src: "../reuse/me.md"
layout: section
---

## みなさん!レビューしてますか
## みなさん!レビューしてますか?

---
layout: section
---

## レビュー好きですか?
## レビューは大変

---

## レビューコメントのラベル

レビューコメントには必ずラベルを付けてもらう運用にしていてた。

| ラベル | 意味 |
| -------- | -------------------------------------------- |
| Must | 必ず直してほしい箇所 |
| IMO | 任意だが自分ならこうする的な意見 |
| NITS | 直さなくても問題ないが修正したほうが良い箇所 |
| Question | 質問 |

- 導入当初は分かりやすくていい印象
- チームでコミュニケーションをしていると改善点が見つかる

---

## レビューコメントのラベル

導入からしばらく経っていたのでちょっと整理してみることに

問題点はなんとなく候補があったので、ドキュメントを書いてチームに共有してみた。

---

## 問題点について

- IMOとNITSの変更要望度が人によって異なる
- Questionが多用され着地点が分からないコメントがある

<img src="/image/review.png" width="400" style="margin: 64px 0 0 auto; mix-blend-mode: plus-lighter;" alt="人によって利用するラベルが違うことを表した図">

<!-- https://excalidraw.com/#json=3cnobLM0GllkyPjPMpGhp,vWhkxvfQSR1z7fckyMVVaA -->

---
layout: center
---

## 改善しよう

---

### IMOとNITSの変更要望度が人によって異なる

話し合うと、ラベルは変更してほしい度合いで使い分けていたことが分かった。

- ラベルの振り分けを変更要望度を基準にする
- IMOとNITSを同じ要望度とする
- Wantというラベルを追加

---

### IMOとNITSの変更要望度が人によって異なる

<img src="/image/label.png" style="background-color: rgb(51 51 51 / 70%);padding: 32px;margin-top: 16px;border-radius: 16px;" alt="ラベルの整理を表した図、Must/IMO/NITS/Questionがバラバラから、Must/Want/IMO or NITS/Askという順になっている">

<!-- https://excalidraw.com/#json=XxwxcWFp166lkW-pgMbuu,nLzak3elk7rny1Mxf_HFRQ -->

変更要望度に合わせてラベルを整理してみた。

---

### Questionが多用され着地点が分からないコメントがある

ある程度整理できたので、変更要望度を軸にドキュメントに記載。

| ラベル | 変更要望度 | 利用シーン |
| ---------- | ---------- | ------------------------------------------------ |
| Must | 100% | 明らかなバグ・仕様と実装の乖離・ガイドライン違反 |
| Want | 99%-50% | パフォーマンスや可読性など非機能要件的な指摘 |
| IMO / NITS | 49%-1% | (主観的な)より良い書き方の提案 |
| Ask | 0% | 質問 |

---
layout: section
---

## 質問が結局残ってますよ?

---

## 質問が結局残ってますよ?

純粋な質問まで禁止してしまうのは厳しいのでラベルは残すことになった。

- 難しそうな実装部分はモブレビューを実施してそのログを残すことに
- 「大丈夫そうですか?」みたいな変更を期待した質問はNGに
- レビューコメントの書き方を工夫して「質問っぽい指摘」になるのを避ける

---

### [おまけ] 質問っぽい指摘を避けるための書き方

- 前提として自分の認識
- 前提が正しかった場合にどのような懸念があるか
- それを解決する方法

<div style="background-color: var(--color-bg-code-block);border-radius: 8px;padding: 1rem;margin-top:32px;">
<p style="line-height:1;"></p>
</div>

---

## まとめ

- レビューのラベルは変更要望度を基準に整理するといい
- 質問っぽい指摘は避けてなるべく具体的にコメントを書く
18 changes: 18 additions & 0 deletions review-comment/styles/mod.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
#app h1 {
font-size: 2.5rem;
}

div#app h3 {
position: relative;
z-index: 10;

&::after {
content: "";
position: absolute;
bottom: 0;
left: 0;
width: 100%;
height: 60%;
transform: skewY(0.5deg) translateY(3px);
background-color: var(--c-accent);
z-index: -1;
opacity: 0.7;
}
}

0 comments on commit 140c20b

Please sign in to comment.