Skip to content

Conversation

@nagutabby
Copy link
Member

No description provided.

@nagutabby nagutabby self-assigned this Jul 21, 2023
# レビューしてほしいところ

## 概要
<!-- 後で取り組む人のためになるべくわかりやすく書きましょう -->

Choose a reason for hiding this comment

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

個人的に、新しく入ってきた人向けに、コメントアウトでどんなことを書くのかは書いたほうがいいかなーと思いました

Copy link
Member Author

Choose a reason for hiding this comment

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

了解です、サンプルテキストをコメントとして記述しておくのはいかがですか?

Choose a reason for hiding this comment

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

コメントっていうのは、PRのコメントです?
PRを作成する→PRにコメントをつけることができる
の流れだと思うので、大体の人はPRを作成するときに概要も記述する人が多いと思うので、PR作ったあとにコメントで例や説明が来ても遅いかなと思ってます。

@nagutabby
Copy link
Member Author

「背景」という表現よりも「変更を加える理由」という表現の方が分かりやすいと思ったので修正します

@nagutabby
Copy link
Member Author

「レビューしてほしいところ」という表現よりも「レビューする際の注意点」という表現の方が分かりやすいと思ったのでこちらも修正します

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants