指摘・レビュー4 択難易度 標準

README のポート番号が誤っていた（3000 と書いたが正しくは 8080）。直し方として適切なのは？

正答

1. README を直し、コミットに「README のポート番号の誤記を修正（3000 → 8080）」と書く
2. README を直し、差分を見れば分かるのでコミットメッセージは「fix」とだけ書く
3. README はそのままにして、チャットで「ポートは 8080 が正しいです」と全員に伝える
4. 番号が変わるたびに誤解を招くので、README からポート番号の記載自体を消しておく

解説

ドキュメントの誤りは、ドキュメント自体を直したうえで、コミットや PR に「何が誤りで、正しくは何か」を書くと、履歴を見た人が以前の記述で設定した環境を直せる。「fix」だけでは何を直したのか分からない。チャットで伝えるだけでは README の誤りが残り、後から来た人がまた間違える。記載を消すと、必要な情報が無くなるだけで問題は解決しない。

correctiondocscommit-message