做一个成功的PHP扩展包,不仅仅是简单的把代码放到一个文件夹里,还有很多因素决定你的扩展是否优秀。以下清单将帮助您的扩展在PHP社区中获得更多关注。1.为你的扩展选择一个合适的名字确保你的名字没有被其他项目使用。扩展的名称需要与您的PHP命名空间相匹配。不要在你的命名空间中使用你自己的名字或任何个人的名字。2.开源你的扩展GitHub可以免费管理这类公共项目。GitHub对您管理这个开源项目非常有帮助,并且可以让其他人轻松获得您的扩展。如果您不想使用它,请尝试替代方案:Bitbucket.3。使用符合PSR-4的自动加载器命名空间自动加载友好。请将代码放在src文件夹中。4.通过Composer发布确保你可以通过Composer找到你的类库,Composer是发布在Packagist上的PHP依赖管理工具,它是一个主要的Composer包仓库。5.不局限于框架不要将项目局限于一个框架。特定于框架的支持是通过服务提供商提供的。6.遵循编码风格强烈建议您坚持使用PSR-2编码风格。使用自动代码格式化工具,例如PHPCodingStandardsFixer。使用代码风格检测工具,例如PHPCodeSniffer。7.编写单元测试覆盖大部分代码。使用PHPUnit,一种流行的PHP单元测试框架。其他选项:phpspec、Behat、atoum、Codeception。8.为代码写注释将注释视为内置文档。代码注释还可以改进IDE(例如PhpStorm)中的代码完成。可以自动转换成API文档,见phpDocumentor。9.使用SemanticVersioning使用SemanticVersioning来管理版本号。遵循majorversion.minorversion.patchversion规范。让开发人员安全地升级软件,而不必担心破坏性更改。记得及时标记发布!10.保持定期更新日志清楚地标记并显示版本之间的重大变化。考虑按照KeepaCHANGELOG格式编写。11、使用持续集成使用服务自动检查编码是否标准,是否能通过运行测试。在多个不同的PHP版本上运行测试是个好主意。确保它可以在提交或拉取时自动运行。参考资料:Travis-CI、Scrutinizer、Circle-CI。12.写大量的使用文档。一个好的文档对于扩展包来说非常重要。至少确保存储库中有详细的自述文件。尝试在GitHubPages 托管文档。可用参考:阅读文档。13.包含许可(License)包含许可协议,可以有效保护你的工作成果,而且很容易做到。请参阅choosealicense.com。大多数PHP开源项目使用MIT许可证。至少在您的代码库中包含一个LICENSE文件。还可以考虑将您的许可协议包含在Docblocks中。14.欢迎大家的贡献。如果你想让每个人都帮助改进项目,那么你必须要求你的贡献!有一份CONTRIBUTING文档,其中包含贡献者列表。使用此文档来解释项目环境要求,例如测试环境。如需更多现代PHP知识,请访问Laravel/PHP知识社区
