如何给 swoft 贡献代码

有许多同学希望或已经在参与贡献代码给 swoft，这里我们非常感谢大家的支持。但是仍然有一些同学不知道如何给我们贡献代码或者贡献代码时 PR 发错位置，又或者格式不够规范 。

这里我简单介绍一下 如何给 swoft 贡献代码。(其实主要的内容在 swoft 项目置顶的 issue 已经有说明)

• 核心组件的 开发仓库 是 swoft/swoft-component
• 扩展组件的 开发仓库 是 swoft/swoft-ext
• swoft/swoft 和 swoft-cli 是一个独立的应用，因此也接受 PR

操作流程#

• 请 fork 对应的 开发仓库
• 修改后，请把你的 PR 提交到对应的开发仓库
• 提交 PR 时，请写明修复了什么问题，改进什么等信息
• 等待开发组人员审查代码
• CI 测试通过，且代码审查通过后，我们会合并 PR
• 代码将会在下次版本中发布

发起 PR 时的注意事项#

我们非常欢迎各位同学提交 PR (Pull Request)，但是为了保证代码质量和统一的风格，向官方的主仓库 swoft/swoft 和 开发仓库 贡献代码时需要注意代码和 commit 格式

请不要提交 PR 到各个组件仓库，它们都是 只读的。 发布版本时官方会将代码自动同步到各个子仓库

Commit 提交规范#

规范提交 commit 信息， 这样 history 看起来更加清晰，还可以自动生成 changelog

• commit message 只能是英文信息
• 请尽量保证 commit message 是有意义的说明
• 最好以 add: update: fix: 等关键字开头
• 更多请参考 angular 规范

代码风格#

• 提交的 PHP 代码 必须 遵循 PSR-2 代码风格
• 合理且有意义的类、方法、变量命名
• 适当的注释，合理的使用空行保持代码的简洁，易于阅读
• 不要包含一些无意义的信息 例如 @author 等 (贡献者是能够从 commit log 或 contributors 里看到的)

本作品采用《CC 协议》，转载必须注明作者和本文链接