src-run / wonka-library
一组框架无关的类、接口、特质和根命名空间函数,用作其他项目的构建块
Requires
- php: ~7.0
- src-run/augustus-deprecation-library: ~0.7
- src-run/augustus-dumper-library: ~0.7
- src-run/augustus-exception-library: ~0.7
- src-run/augustus-file-lock-library: ~0.7
- src-run/augustus-log-library: ~0.7
- src-run/augustus-polyfill-library: ~0.6
- src-run/augustus-primitive-library: ~0.6
- src-run/augustus-reflection-library: ~0.7
- src-run/augustus-silencer-library: ~0.7
- src-run/augustus-utility-library: ~0.6
Requires (Dev)
- codacy/coverage: ~1.0
- friendsofphp/php-cs-fixer: v2.0.0-alpha
- phpunit/phpunit: ~5.4
- psr/log: ~1.0
- satooshi/php-coveralls: ~1.0
- sllh/php-cs-fixer-styleci-bridge: ~2.1
README
概述
欢迎! src-run/wonka-library
包提供以下功能
一组框架无关的类、接口、特质和根命名空间函数,用作其他项目的构建块。
分组
我们使用灵感来自Willy Wonka的命名规范为我们的包分组命名。此包是wonka分组的一部分,该分组是一组以“核心反射基类”和相关功能为重点的包。
如果你手头有太多空闲时间,欢迎你研究一些关于这个特定组无用的细节。
JTT
此包代表在大量开源代码集合中一个项目,这些代码在“SR”命名空间下发布,包括许多框架无关的库、一组Symfony扩展包以及一些单独发布的项目。此项目由以下人员编写和维护:
快速开始
安装
通过CLI使用Composer显式地要求代码,或者通过编辑你的composer.json以反映依赖项并更新你的项目要求来获取代码。例如,要使用CLI显式地要求此项目,请使用以下命令。
$ composer require src-run/wonka-library
或者,要将此项目添加到你的“composer.json”文件中,请将以下内容添加到“require”部分。
require: { "src-run/wonka-library": "dev-master" }
注意:不推荐使用“dev-master”约束。了解这样做可能会允许向后不兼容的、破坏性的更改被拉入。相反,使用语义版本控制并显式要求是良好的实践。例如,要要求版本1.0,请使用^1.0
。
参考
API文档
此包的API参考可在我们的文档网站上找到(请参阅下文“附加链接”部分中的“参考”行的表格)。所有API文档都在git push事件发生时自动编译针对master分支。
计划为特定版本提供静态API参考,并将在此包成熟并达到版本1里程碑时发布。.
上述API参考网站是使用名为Sami的可靠且高度发展的CLI工具自动生成的。它经过严格且定期的测试,并被用于一些大型项目,如Symfony全栈框架 <see: https://src.run/go/symfony-api>,以及一些小型项目,如Twig <see: https://src.run/go/twig-api>。请参阅Sami的存储库页面以研究在你自己的项目中使用它。
示例/教程
目前,除了这个README(它本身也是从模板生成的)之外,没有其他“人工编写”的文档。待项目包稳定、可用的工时以及外部用户的实际需求确定后,我们可能会发布一个包含官方文档、教程和额外资源的Read the Docs页面。
贡献
讨论
如需进行一般咨询或讨论广泛的话题或想法,请查找Freenode上的“robfrawley”。他乐于讨论语言层面的想法、项目可能的新的发展方向、新兴技术,以及天气。
问题
如需报告问题或请求新功能,请使用项目问题跟踪器。在任何错误报告中包含尽可能多的信息。如果在几天内没有收到回复,请随时“ping”该主题(有时GitHub的通知电子邮件会丢失)。
代码
在使用此包的同时创建了额外的功能?太棒了:将它发回上游!不要犹豫提交pull请求!您的想象力和我们在CONTRIBUTING.md文件中概述的要求是唯一限制。
许可证
本项目采用MIT许可证,这是一种由FSF和OSI批准的、与GPL兼容的、宽容的自由软件许可证。有关更多信息,请参阅与源代码一起分发的LICENSE文件。