Docs header transparent bg

提交 Pull Request

在提交 Pull Request 之前,请记住执行以下操作:

  1. 检查代码格式和风格
  2. 运行测试套件
  3. 使用有意义的提交信息,不要使用标签

代码格式

确保代码格式和样式符合指南。我们使用 RuboCop 来执行此操作。不符合格式要求将导致 GitHub Actions 自动构建失败。

  $ rake rubocop

测试

在提交 PR 之前,请运行测试套件

  $ bin/parallel_rspec

如果您无法运行整个测试套件,请运行单元测试套件,以及至少与您的代码更改相关的 Bundler 命令或域相关的集成规范。

例如,对于更改 bundle update 的 Pull Request,您可能需要运行

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

提交信息

请确保 Pull Request 中包含的提交信息**不**包含以下内容: - @tag GitHub 用户或团队引用(例如 @indirect@bundler/core) - #id 对问题或 Pull Request 的引用(例如 #43rubygems/bundler-site#12

如果您想使用这些机制,请将其包含在 Pull Request 描述中。这可以防止在提交变基或 Pull Request/分支强制推送时创建多个通知或引用。

此外,请勿在 Pull Request 标题/描述或提交信息中使用 [ci skip][skip ci] 机制。每个潜在的提交和 Pull Request 都应该通过 Bundler 的 CI 系统运行。这适用于所有更改/提交(例如,即使是仅对文档或删除注释的更改)。

在 GitHub 上编辑此文档,如果您发现错误或遗漏。