Pull Request のガイドライン

Pull Request(PR)は、リポジトリにパッチを送信する手順です。問題が発生しないようにするため、新しい機能について話し合う前に問題を見つけて開くようにしてください。これにより、コアチームがプロジェクトの範囲と目標に適していない機能に時間を無駄に費やすのを防ぐことができます。

機能やバグについて調査したら、PR を送信します。パッチをできるだけ早く適用できるように、以下手順に従ってください。

関連ファイルのみを変更する

PR を 1 つの機能に集中させてください。プロジェクトの設定や作業対象の件名に関連していないファイルを何も変更しないでください。件名ごとに 1 つの PR を開きます。

コードがクリーンであることを確認する

プロジェクトの スタイルガイド をチェックアウトして、コードが準拠していてクリーンであることを確認してください。デバッグの行(デバッガーconsole.log)を削除します。

変更内容の単体テストを実施する

機能を追加しますか?サポートするための単体テストを追加します。

バグを修正しますか?問題を再現するテストを追加します。

テストに合格する

プロジェクトのすべての単体テストは、プロジェクトのルートで npm test と入力すると実行されます。mochagrunt、または gulp などの依存関係をインストールする必要がある場合があります。

コミット履歴を短くクリーンに保つ

大きなプロジェクトでは、git 履歴をきれいに整頓することが重要です。これにより、バグの原因を特定して最適な修正方法を特定できます。

履歴をクリーンに保つとは、1 つの機能に対して 1 つのコミットを行うことを意味します。また、チームのレビュー後にブランチで修正したすべてを squash することも意味します。

履歴をクリーンに保つことがなぜ重要なのか疑問ですか?アイザック・シュルーター(元 Node.js リード)の記事 をお読みください。「Git はエディターです」ということを覚えておいてください。

説明を付ける

PR について説得力のある説明と、適用する必要がある理由を記載します。

コードレビュー中に対応する

コアコードをクリーンで一貫性のある状態に保つことが重要です。つまり、コードレビューを厳しく行います!

コードレビューは、エンジニアとして上達するための最良の方法です。レビューを個人攻撃として受け取らないでください。それらは Yeoman を整理し、向上させるために行われます。

コードレビューの詳細はこちら をお読みください。