README

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

本说明包含有关此模块基础部分的描述，您应根据您自己的模块需求进行自定义。例如，上述 H1 中的模块名称应为您自己的模块名称，而现在您正在阅读的描述文本是您提供有关您的模块功能良好简短解释的地方。

在可能的情况下，我们已经包括了可以原样包含到您的模块中的默认文本，并在其他地方指出您需要对其进行自定义的地方。

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

将此存储库克隆到文件夹中
将您的姓名/组织添加到 LICENSE.md
更新此说明，包含有关您的模块的信息。确保删除不相关的部分，并在相关位置编辑占位符
审查提供的目录中的 README 文件。您应将其替换为 .gitkeep 或删除目录
使用您的需求更新模块的 composer.json
使用您的需求更新（或删除）package.json。运行 yarn（或删除 yarn.lock）以确保依赖项正确解析
通过运行 rm -rf .git && git init 清除 git 历史
添加并推送到 VCS 存储库
在 packagist.org 上发布模块，或将自定义存储库添加到您的主 composer.json
在您的主 composer.json 中要求模块
如果您需要构建 JS 客户端
- 确保使用 composer install --prefer-source 安装 vendor/silverstripe/admin，而不是默认的 --prefer-dist。您可能需要首先从供应商文件夹中删除模块。
- 通过在两个位置运行 yarn install 在您的模块中以及在 vendor/silverstripe/admin 中安装第三方依赖项
开始开发您的模块！

需求

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

composer require silverstripe-module/skeleton 4.x-dev

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

我们包含了一份3条款BSD许可协议，您可以使用它作为默认许可。我们推荐使用BSD许可，因为它是最宽松和最开放的许可之一。

如果您想使用其他许可，请随意修改license.md。您可以使用choosealicense.com来帮助您为项目选择合适的许可。

除非您的模块只需要最少的文档，否则请在此将链接添加到您的docs/文件夹。您可能将其用作快速目录表，如果您有多个文档页面。

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

尽可能提供yaml代码示例。

Page:
  config_option: true
  another_config:
    - item1
    - item2

错误在此存储库的问题部分跟踪。在提交问题之前，请先阅读现有问题以确保您的独特性。

如果问题看起来像是一个新错误

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

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