如何贡献我的源代码

此文档介绍了Typecho团队的组成以及运转机制,您提交的代码将给Typecho项目带来什么好处,以及如何才能加入我们的行列.

通过 Github 贡献代码

Typecho 目前使用 Git 来控制程序版本,如果你想为 Typecho 贡献源代码,最好先弄明白 Git 的使用方法。我们目前把项目托管在 GitHub 上,任何 GitHub 用户都可以向我们贡献代码。

参与的方式很简单,【Fork】一份 Typecho 的代码到你的仓库中,修改后提交,并向我们发起【Pull Request】申请,我们会及你的申请并及时对代码进行审查。审查通过后,你的代码将被【Merge】进我们的仓库中,这样你就会自动出现在贡献者名单里了,非常方便。

我们希望你贡献的代码符合:

  1. Typecho 的编码规范
  2. 适当的注释,能让其他人读懂
  3. 遵循 GPL v2 协议

第三方包集成规则

在Typecho中,所有的程序文件以包(package)形式组织。我们亦集成了一些优秀的第三方开源包,向Typecho贡献包文件是最常见和容易的实现方式。我们对包文件的集成方式采用如下两种方案:

  1. 对于可以直接独立使用的包,我们会直接放在/var目录下,供程序直接使用。比如IXR包。
  2. 对于需要整合才能使用的包,我们会集成到/var/Typecho目录下,作为Typecho包的一个子集。比如Feed和I18n包,它们都是被我们扩展或修改后使用的。

不论是否会被我们修改,我们都将遵循第三方包的发行协议,并保留作者版权(如果有的话),我们将在文件头部声明出处。并尽可能得保留程序注释与代码风格。对于经过修改的包,我们会标注我们修改的地方。