本文档解释了 Font Awesome 存储库的 pull request 流程,包括重要的限制、提交指南和最佳实践。Font Awesome 项目的 pull request 方法与许多开源项目不同。本文档专门介绍通过 pull request 进行的代码贡献;有关提交图标请求的信息,请参阅提交图标请求,有关报告 bug 的信息,请参阅报告 bug。
来源: CONTRIBUTING.md17-24 .github/PULL_REQUEST_TEMPLATE.md1-6
Font Awesome pull request 流程中最重要的方面是此存储库中的 pull request 无法合并。这是项目的基本政策。
图示:Pull Request 参考流程
提交到 Font Awesome 存储库的 pull request 仅作为参考实现。它们展示了贡献者希望看到的更改,但需理解
来源: .github/PULL_REQUEST_TEMPLATE.md1-6
Font Awesome 存储库中的许多文件是通过内部构建系统生成的。这种架构使得直接合并外部 pull request 在技术上具有挑战性,即使这符合项目的政策。
图示:已生成文件和 PR 限制
以下贡献不接受通过 pull request 提交
以下类型的贡献可能会被考虑
| 贡献类型 | 接受策略 | 正确的渠道 |
|---|---|---|
| 新图标 | 不通过 PR | 图标请求 issue |
| 品牌图标 | 不通过 PR | 品牌请求 issue |
| Bug修复 | 仅供参考 | 引用现有 issue 的 PR |
| 功能实现 | 仅供参考 | 引用已批准的功能请求的 PR |
| 文档 | 仅供参考 | 具有专注更改的 PR |
图示:Pull Request 提交顺序
提交拉取请求时
来源: CONTRIBUTING.md19-24 .github/PULL_REQUEST_TEMPLATE.md3-6
不解决现有 issue 的 pull request 被认为优先级较低,可能不会得到及时关注。Font Awesome 团队优先处理
图示:Pull Request 优先级
创建 pull request 时,请专注于单一问题,避免包含无关的更改。这使得 Font Awesome 团队更容易理解和潜在地实现你建议的更改。
包含有关你的代码已在哪些浏览器中测试过的信息。这有助于团队了解你提议更改的兼容性。
在你的 pull request 描述中,始终使用 GitHub issue 引用语法(例如,“Fixes #123”或“Addresses #456”)引用相关的 issue。
包含你更改的清晰文档,说明
提交 pull request 后
Font Awesome 团队对正式版本包含的内容拥有完全控制权,但重视社区通过 PR 流程提供的输入和建议。