README

#KretaSimpleApiDocBundle

一个在NelmioApiDocBundle之上生成API文档的包。

##测试此包完全由 PHPSpec，PHP的SpecBDD框架进行测试。

因为你想贡献或者只是想运行测试，你需要在终端中输入以下命令。

$ vendor/bin/phpspec run -fpretty

##贡献此库遵循PHP编码标准，所以pull请求需要执行Fabien Potencier的PHP-CS-Fixer和Marc Morera的PHP-Formatter。此外，如果PR创建了某些非PHP文件，请记住您需要手动添加许可证头。为了简化，我们提供了一组Composer脚本，它封装了与此过程相关的所有命令。

$ composer run-script cs

为此项目做出贡献还有一项政策。pull请求必须逐步解释，以便于审查过程，以便接受和合并它们。新的方法或代码改进必须与PHPSpec测试配对。

如果您想做出贡献，那么遵循Symfony贡献标准是一个好的起点，因此请阅读项目文档中的贡献代码。如果您正在提交pull请求，请遵循提交补丁部分中的指南，并使用Pull Request模板。

如果您有任何疑问或可能想要分享一些意见，您可以使用我们的 Gitter聊天。

##待办事项

ValidationParser类的单元测试
ApiDocExtractor类的单元测试

##致谢克里特简单API文档包由以下人员创建

@benatespina - benatespina@gmail.com
@gorkalaucirica - gorka.lauzirika@gmail.com

##许可选项

kreta / simple-api-doc-bundle

维护者

详细信息

README