README

持续集成	代码质量审查	单元测试覆盖率

概述

欢迎！ scr-be/mantle-bundle 包主要用于Scribe Inc的网站和客户网站。它包括了满足我们开发需求的所有包的集合。

分组

此包是 mantle 组的一部分 (解释)，该组集中了框架基础和相关功能的其他发布版本。

JTT

此包代表了一个在 大型开源代码集合 中的一个项目，该集合在 Scribe 命名空间下发布，包括与框架无关的库和多个Symfony捆绑包。这些项目由 Rob Frawley 2nd 和 合作者 编写和维护，通常得到 Scribe Inc 的支持。

快速开始

安装

通过使用 Composer CLI显式地获取代码，或者通过编辑你的 composer.json 来反映依赖关系并更新你的项目需求。例如，要使用CLI显式地要求此项目，请使用以下命令。

$ composer require scr-be/mantle-bundle

要启用此捆绑包，请在Symfony应用程序内核中将其注册，通过在捆绑包数组中实例化 ScribeMantleBundle。

// app/AppKernel.php
class AppKernel extends Kernel {
    public function registerBundles() {
        $bundles = [
            // ...
            new Scribe\MantleBundle\ScribeMantleBundle(),
        ];
        // ...
    }
}

配置

可以使用Symfony控制台命令 app/console（假设使用Symfony全栈框架和捆绑包注册）来引用可用的配置值。此外，此捆绑包提供了一个裸控制台可执行文件，可以通过以下方式调用。

bin/mantle config:dump-reference scribe_mantle

参考

API文档

此包的API文档可在 scr.be/mantle-bundle/api 找到（以及如下文中的 参考 徽章下链接的 附加链接 标题）。所有API参考都是针对 master Git分支构建的，并在每次Git推送时自动更新——一旦此包成熟，将提供 特定版本 的API参考。

整个API参考网站都是使用名为Sami的快速、可靠且功能完善的命令行工具自动生成的。Sami可以在Sami的GitHub页面上找到。它通过在大型、复杂的项目中使用进行严格且定期的测试，例如Symfony全栈框架（scr.be/go/api-ref-symfony>），以及在其Twig项目中的使用（scr.be/go/api-ref-twig>）。要了解如何将其用于您自己的项目，请参阅Sami的GitHub页面！

示例/教程

目前，除了README之外，没有其他“人工编写”的文档。待软件包稳定和可用资源充足后，将发布RTD（Read the Docs）页面，其中包含更多信息、教程，包括在Symfony框架中的实际用例。

贡献

讨论

如果您想咨询一般问题或讨论一个广泛的主题或想法，您可以在Freenode上找到robfrawley。还有一个#scribe频道，您可以通过以下链接加入：irc.choopa.net:6669/scribe。

问题

要报告问题或请求新功能，请使用GitHub或GitLab开始讨论。请提供尽可能多的信息，以帮助快速解决问题。如果您几天内没有收到回复，请随时“ping”该主题。

代码

您在使用此软件包时创建了额外的功能？将其发送回上游！不要犹豫提交拉取请求！除了在贡献指南中概述的简短要求之外，您的想象力是唯一的限制。

许可

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

其他链接

目的	状态
稳定版本
开发版本
许可
参考