PRを発行してコードをレビュー(質問に解答)していただいた時にアドバイスされたこと
コードをレビューしていただく機会がありその内容を忘れないために備忘録として残しておきます。
使用しているサイト・ツール
qiitaで以下の素晴らしい記事を見つけました。
qiita.com
今回はそれとは別に自分がアドバイスいただいた内容を列挙します。
【その前に1】PRを作成するときに必要なこと
先述したqiitaの該当箇所がわかりやすくとても丁寧です。
リンクを貼っておきます。
https://qiita.com/hinora/items/fb083a97d6e2ab8a9aa3#--%E3%83%97%E3%83%AB%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88
項目としては大きく4つで
- 概要
- issue またはチケットへの関連づけ
- 画像を
- コミュニケーション
に大きく分類されるそうです。
教えていただいたこと
アサインされた機能を実装できずに困っていたらPRに詳細を書く
最初はどうしても実装できずに困ってSlackでやりとりして質問していました。
アドバイスいただいた方も仕事をされており、かなり忙しいので効率的に問題解決しようと
どうしても自分で解決できなかった場合はGitHubでPRを作成して具体的にどう詰まっているかをそこに書いてください。
とアドバイスしていただきました。
1 のところはてっきり困っている内容を書いてはいけないと思っていました。
人によって賛否はあるかもしれませんがこの手法を取り入れてからアドバイスいただく方とのやりとりがスムーズになりました。
また最近になって気づきましたがレビューしていただく方も忙しいので以下を参考に作成することを心がけていきたいと思います。
www.sejuku.net
Markdownに画像を貼る(Gyazo)
PRを作成した時に、実装できた証明としてスクショが欲しいと言われました。
つい最近までmacのスクリーンショット 機能を使用していましたが、
Gyazoがあるのでそれを使ってみましょう
と言われ、このときに初めてGyazoの存在を知りました。
リンクを載せておけばよいと勝手に誤解釈してしまっていたのですが、それではダメでリンクを使用して表示する方法を使ってくださいとのことでした。
やり方を教えていただいた後に
で調べてみるとあるじゃありませんか、わかりやすい記事が...
以降は以下の記事を参考にして効率的に画像リンクを作成しています。
webrandum.net
雑感
個人開発しているとわからないこと、知らないことがあることを改めて実感しました。
P.S.
あと5日で2022年に突入...
よいお年をw