README

Travis-CI	Codacy 评分	代码覆盖率	Style-CI

概述

欢迎！src-run/wonka-library包提供了以下内容：

一组框架无关的类、接口、特性和根命名空间函数，用作其他项目的构建块。

分组

我们使用一个灵感来自Willy Wonka的命名约定为我们的包分组命名。此包是wonka分组的一部分，该分组是一组专注于“核心反射基类”和相关功能的包。

如果您手头有很多时间，欢迎您研究一些关于此特定分组的无用细节。

JTT

此包代表一个大型开源代码集合中的一个项目，该代码集合在“SR”命名空间下发布，包括许多框架无关的库、一组Symfony扩展包以及一些单独发布的项目。该项目由以下人员编写和维护：

• Rob Frawley 2nd
• 合作者

快速开始

安装

通过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。它经过严格和定期的测试，并被用于一些大型项目，例如Symfony全栈框架（https://src.run/go/symfony-api>），以及一些小型项目，例如Twig（https://src.run/go/twig-api>）。请参考Sami的仓库页面，以了解如何在您的项目中使用Sami。

示例/教程

目前，除README（本身也是从模板生成）之外，没有“人工编写的”文档。待软件包稳定、可用工时以及有外部用户实际需求后，我们可能会发布一个Read the Docs页面，包含官方文档、教程和额外资源。

贡献

讨论

要咨询一般性问题或讨论广泛的话题或想法，请在Freenode上找到“robfrawley”。他总是愿意讨论语言级想法、项目可能的新的发展方向、新兴技术，以及天气。

问题

要报告问题或请求新功能，请使用项目问题跟踪器。在任何错误报告中尽可能提供尽可能多的信息。如果您几天内没有收到回复，请随时“ping”该主题（有时GitHub通知电子邮件会丢失）。

代码

在利用此软件包时您创建了额外的功能？太好了：请将其发送回上游！不要犹豫提交拉取请求！您的想象力以及我们CONTRIBUTING.md文件中概述的要求是唯一的限制。

许可

本项目采用MIT许可证，这是一个由FSF和OSI批准的、与GPL兼容的、宽松的自由软件许可证。请查阅随源代码一起分发的LICENSE文件以获取更多信息。

附加链接

项目	结果/状态
稳定版本
开发版本
许可证
参考