README

这是一个有用的骨架，可以更轻松地创建符合模块标准的模块。

本说明中包含了对本模块基础的各部分进行描述，以满足您的模块需求。例如，上面 H1 中的模块名称应该是您自己的模块名称，而现在阅读的描述文本是您提供模块功能良好简短解释的地方。

在可能的情况下，我们已包含默认文本，可以将其直接包含到您的模块中，并在其他地方指示您需要对其进行自定义。

以下是您在 readme.md 中应理想地包含的章节模板，以符合模块标准并帮助他人使用您的模块。

请注意：此模块设计为“供应商模块”。如果您需要将其用作非供应商模块，您将需要调整 silverstripe/admin JS 和 SCSS 加载器的导入路径。

要求

在此处添加一些安装说明，有一个 composer 复制粘贴命令很有用。以下是一个创建新模块项目的 composer 命令。请确保您已阅读 '发布模块' 指南并更新您的模块的 composer.json，以将您的代码指定为 SilverStripe 模块。

composer require robbieaverill/silverstripe-module 2.x-dev

注意：当您完成模块后，将其提交到 Packagist 或将其作为 VCS 仓库添加到您的项目的 composer.json 中，指向私有仓库 URL。

我们包含了一个 3 条款 BSD 许可证，您可以将其用作默认许可。我们倡导使用 BSD 许可证，因为它是最开放和最宽松的许可证之一。

如果您想使用替代许可证，请随意更改 license.md。您可以使用 choosealicense.com 来帮助选择适合您项目的合适许可证。

在此处添加到 docs/ 文件夹中的链接，除非您的模块仅需要最小量的文档，在这种情况下，请在此处添加并删除 docs 文件夹。如果您有多个文档页面，您可能将其用作快速目录表。

如果您的模块使用 SilverStripe 的配置 API，提供一个示例配置是个好主意，这样模块就可以直接工作并展示给用户可能的配置选项。

尽可能提供 yaml 代码示例。

Page:
  config_option: true
  another_config:
    - item1
    - item2

问题在本仓库的问题部分跟踪。在提交问题之前，请阅读现有的问题，以确保您的問題是独特的。

如果问题看起来像是一个新漏洞

请直接向模块维护者报告安全问题。请不要在漏洞跟踪器中提交安全问题。

如果您想为模块做出贡献，请确保提出一个拉取请求，并与模块维护者进行讨论。