README

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

本说明包含有关您应自定义以满足您自己的模块需求的此模块基的各个部分的说明。例如，上述 H1 中的模块名称应该是您自己的模块名称，而您现在正在阅读的描述文本是您应提供一个关于您的模块做什么的简洁说明的地方。

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

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

准备此模块以供您使用的方法

• 将此存储库克隆到一个文件夹中
• 将您的姓名/组织添加到 LICENSE.md
• 使用有关您模块的信息更新此说明。确保删除不相关的部分，并在相关位置编辑占位符
• 检查提供目录中的 README 文件。您应将这些文件替换为 .gitkeep 或删除这些目录
• 使用您的需求更新模块的 composer.json
• 使用您的需求更新（或删除）package.json。运行 yarn（或删除 yarn.lock）以确保依赖项正确解决
• 通过运行 rm -rf .git && git init 清除 git 历史
• 添加并推送到一个版本控制系统存储库
• 在 packagist.org 上 发布 模块，或将其 自定义存储库 添加到您的主 composer.json
• 在主 composer.json 中要求模块
• 开始开发您的模块！

需求

• SilverStripe ^4.0
• Yarn，NodeJS (6.x) 和 npm（用于构建前端资源）
• 其他模块
• 其他服务器要求
• 等

安装

在此处添加一些安装说明，有 1 行 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/ 文件夹中，除非您的模块只需要最少量的文档。在这种情况下，请在此处添加并删除 docs 文件夹。如果您的文档页面较多，这可以作为一个快速的内容表。

示例配置（可选）

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

尽可能提供 yaml 代码示例。

Page:
  config_option: true
  another_config:
    - item1
    - item2
  

维护者

• 此人为 person@emailaddress.com
• 另一位维护者 maintain@emailaddress.com

错误追踪

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

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

• 创建一个新的问题
• 描述重现您的问题所需的步骤以及预期的结果。单元测试、截图和屏幕录制可以在这里有所帮助。
• 尽可能详细地描述您的环境：SilverStripe 版本、浏览器、PHP 版本、操作系统、安装的任何 SilverStripe 模块。

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

开发和贡献

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