Docs header transparent bg

プルリクエストを送信

プルリクエストを送信する前に、次の点に留意してください

  1. コードのフォーマットとスタイルを確認
  2. テストスイートを実行
  3. タグを含まない、意味のあるコミットメッセージを使用

コードのフォーマット

コードのフォーマットとスタイルがガイドラインに従っていることを確認してください。このため、RuboCop を使用します。フォーマットがガイドラインに従っていない場合は、GitHub Actions ビルドが自動的に失敗します。

  $ rake rubocop

テスト

PR を送信する前に、テストスイートを実行してください

  $ bin/parallel_rspec

テストスイート全体を実行できない場合は、単体テストスイートと、コードの変更に関連する Bundler のコマンドまたはドメインに関連する統合スペックを実行してください。

例: bundle update で何かを変更するプルリクエストの場合は、以下を実行します

  $ bin/rspec spec/bundler
  $ bin/rspec spec/commands/update_spec.rb

コミットメッセージ

プルリクエストに含まれるコミットメッセージには次のものが **含まれない**ようにしてください:

これらのメカニズムを使用する場合は、プルリクエストの説明に含めてください。これにより、コミットの再ベースまたはプルリクエスト/ブランチの強制プッシュ時に複数の通知または参照が作成されることを防止できます。

さらに、プルリクエストのタイトル/説明またはコミットメッセージには [ci skip] または [skip ci] メカニズムを使用しないでください。すべての潜在的なコミットとプルリクエストは、Bundler の CI システムを通じて実行する必要があります。これは、すべての変更/コミット(たとえドキュメントの変更やコメントの削除であっても)に適用されます。

GitHub でこのドキュメントを編集 (エラーを見つけた場合や、記載もれがある場合)