Skip to content

Comments

コードレビューガイドライン: Add w=1のtips#46

Merged
ma91n merged 1 commit intomainfrom
feature/review_w=1
Feb 10, 2025
Merged

コードレビューガイドライン: Add w=1のtips#46
ma91n merged 1 commit intomainfrom
feature/review_w=1

Conversation

@ma91n
Copy link
Collaborator

@ma91n ma91n commented Feb 10, 2025

w=1 の旨を追加

@ma91n ma91n added the enhancement New feature or request label Feb 10, 2025
@ma91n ma91n self-assigned this Feb 10, 2025
@bolt-new-by-stackblitz
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 10, 2025

指摘内容の補足情報があれば追加するとベターである。例えば、「◯◯の観点で、このコードは△△の懸念があるため、□□□になるように修正をお願いします。公式ブログの{URL}にも記載があり、参考にできると思います。」といった形式である。

レビュイーが自分で調べれば事足りる場合もあるが、レビュアー側が出典を示すことで納得感が増す。また、誤った記事(過去のバージョンの記事や、見当違いの記事)を読んでしまい空回ってしまうことも、探す手間も減る。

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「指摘内容は具体的であればあるだけ良い」と「指摘内容を論理的に説明できないのであれば、コメントすべきではない」は関連性が強い章であるため、順番を入れ替え

@ma91n ma91n merged commit cdf0e2a into main Feb 10, 2025
3 checks passed
@ma91n ma91n deleted the feature/review_w=1 branch February 10, 2025 04:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant