向 CodeIgniter 贡献你的力量

由 LYUHE 创建, 最后一次修改 2016-02-24

向 CodeIgniter 贡献你的力量

CodeIgniter 是一个社区驱动的项目,它会接受从社区里贡献的文档和代码。 这些贡献都是通过 GitHub 上 CodeIgniter 代码仓库 的 Issues 或者 Pull Requests 的形式来完成的。

Issues 是一种快速提交 bug 的方式,如果你发现了一个 CodeIgniter 的 bug 或文档错误,那么请先 看看下面这几点:

  • 是否已经存在一个打开的 Issue
  • 该 Issue 是否已经被修复了(检查下 delevop 分支的代码,或者已关闭的 Issues)
  • 这个 bug 很明显你一个人就能修复吗?

提交 Issues 是非常有用的,但是更好的做法是发起一个 Pull Request ,具体的做法是先 fork 主仓库的代码,然后将修改的代码提交到你自己的副本中。这需要你会使用版本控制系统 Git 。

支持

请注意,GitHub 并不是用来回答一般的技术支持类问题的!

如果你在使用 CodeIgniter 的某个功能时遇到了问题,请到论坛提问。

如果你不知道自己做的对不对,或者不确定自己找到了一个 bug ,也请先到论坛里提问。

提交好问题的技巧

使用描述性的标题(如:解析器类在处理逗号时出错),而不是使用模糊不清的标题(如:我的代码出错了)

在一份报告中只提交一个问题。

在问题中指出 CodeIgniter 的版本(如:3.0-develop),以及出问题的组件(如果你知道的话)(如:解析器类)

解释清楚你希望出现什么结果,以及当前出现的结果是什么。 如果有错误信息的话,并附上错误信息和堆栈信息。

如果有助于阐述你的问题的话,你可以包含少量的代码片段。 如果有大量的代码或截图的话,可以使用类似于 pastebin 或者 dropbox 这样的服务,不要在问题报告中包含这些内容。 为这些内容设置一个合理的过期时间,至少在问题被解决或关闭之前确保它们能访问。

如果你知道如何修复该问题,你可以 fork 并在你自己的分支中修改,然后提交一个 pull request 。 并将上面说的问题报告作为 pull request 的一部分。

如果能在问题报告中描述问题重现的详细步骤,那将是极好的。 如果你还能提供一个单元测试用例来重现该错误,那将更好,因为这给了修复这个问题的人一个更清晰的目标。

指导手册

这里是如何提交 Pull Requests 的一些指南,如果你提交的 Pull Requests 没有遵循这篇指南中提出的这些, 你的提交可能会被拒绝并要求你重新提交。这可能听起来有点难,但是为了保证我们的代码质量这是必须要做的。

PHP 代码规范

所有的代码都必须符合 代码规范指南,它其实就是 Allman 缩进风格 加上下划线规则以及可读的操作符。遵循代码规则可以让代码的风格保持一致,同时也意味着代的更可读性更好。

文档

如果你的修改同时也需要在文档中另加说明,那么你也需要在文档中加上它。新的类、方法、参数、默认值的修改 等等这些都需要对文档做相应的调整。每一处修改也必须要在代码的变更日志(change-log)中进行更新。另外, PHP 的文档注释块(PHPDoc blocks)也要修改。

兼容性

CodeIgniter 推荐使用 PHP 5.4 或更高的版本,但是同时它也对 PHP 5.2.4 保持兼容,所以所有提交的代码都必须 满足这一点。如果你用到了 PHP 5.3 (或以上版本)中的函数或新特性,这些代码需要回退到 PHP 5.2.4 版本的。

分支

CodeIgniter 使用了 Git-Flow 分支模型, 这要求所有的 pull request 应该提交到 develop 分支,develop 分支是正在开发的打算在下一版发布的分支, master 分支总是包含最新的稳定版并保持干净,这样可以在譬如出现紧急安全漏洞时快速的在 master 分支代码 上打上补丁并发布新的版本,而无需担心新加的功能会影响它。正是因为这个原因,所有的提交都应该在 develop 分支,发送到 master 分支的提交会被自动关闭。如果你的提交中包含多处修改,请将每一个修改都放到你独立的分支中。

一次只做一件事:一个 pull request 应该只包含一个修改。这不是意味着说一次提交,而是一次修改(尽管大多数时候 一次提交就是一次修改)。这样做的原因是如果你在同一个 pull request 中修改了 X 和 Y ,但是我们希望能合并 X 同时不想合并 Y ,这时我们就无法合并你的请求。你可以使用 Git-Flow 分支模型为每一个功能创建一个独立的分支, 然后提交两个请求。

签名

你必须对你的工作进行签名,保证这些工作是你原创的或者不是你原创的但是你有将它们添加到开源项目中的权利。 在 Git 中签名并没有得到足够重视,所以你几乎用不到 --signoff 参数,但是在你提交代码到 CodeIgniter 时, 必须使用该参数。

git commit --signoff

或简写:

git commit -s

这个命令会根据你 git 的配置信息在你的提交中添加签名,例如:

Signed-off-by: John Q Public .public@example.com](mailto:john.public%40example.com)>

如果你正在使用 Tower 客户端,在提交窗口中会有一个 "Sign-Off" 复选框,或者你可以将 git commit 设置成 git commit -s 的别名,这样你就不用关心提交中的签名了。

通过这种方式对你的工作进行签名,说明你将遵守 DCO (Developer's Certificate or Origin),Developer's Certificate of Origin 1.1 申明的当前版本位于这份文档的根目录下。

以上内容是否对您有帮助:
二维码
建议反馈
二维码