120 lines
4.3 KiB
Markdown
Executable File
120 lines
4.3 KiB
Markdown
Executable File
如何贡献我的源代码
|
||
===
|
||
|
||
此文档介绍了 ThinkPHP 团队的组成以及运转机制，您提交的代码将给 ThinkPHP 项目带来什么好处，以及如何才能加入我们的行列。
|
||
|
||
## 通过 Github 贡献代码
|
||
|
||
ThinkPHP 目前使用 Git 来控制程序版本，如果你想为 ThinkPHP 贡献源代码，请先大致了解 Git 的使用方法。我们目前把项目托管在 GitHub 上，任何 GitHub 用户都可以向我们贡献代码。
|
||
|
||
参与的方式很简单，`fork`一份 ThinkPHP 的代码到你的仓库中，修改后提交，并向我们发起`pull request`申请，我们会及时对代码进行审查并处理你的申请并。审查通过后，你的代码将被`merge`进我们的仓库中，这样你就会自动出现在贡献者名单里了，非常方便。
|
||
|
||
我们希望你贡献的代码符合：
|
||
|
||
* ThinkPHP 的编码规范
|
||
* 适当的注释，能让其他人读懂
|
||
* 遵循 Apache2 开源协议
|
||
|
||
**如果想要了解更多细节或有任何疑问，请继续阅读下面的内容**
|
||
|
||
### 注意事项
|
||
|
||
* 本项目代码格式化标准选用 [**PSR-2**](http://www.kancloud.cn/thinkphp/php-fig-psr/3141)；
|
||
* 类名和类文件名遵循 [**PSR-4**](http://www.kancloud.cn/thinkphp/php-fig-psr/3144)；
|
||
* 对于 Issues 的处理，请使用诸如 `fix #xxx(Issue ID)` 的 commit title 直接关闭 issue。
|
||
* 系统会自动在 PHP 5.4 5.5 5.6 7.0 和 HHVM 上测试修改，其中 HHVM 下的测试容许报错，请确保你的修改符合 PHP 5.4 ~ 5.6 和 PHP 7.0 的语法规范；
|
||
* 管理员不会合并造成 CI faild 的修改，若出现 CI faild 请检查自己的源代码或修改相应的[单元测试文件](tests)；
|
||
|
||
## GitHub Issue
|
||
|
||
GitHub 提供了 Issue 功能，该功能可以用于：
|
||
|
||