README

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

本 README 包含了此模块基类的描述，您应根据自己的模块需求进行定制。例如，上面的 H1 中的模块名称应该是您自己的模块名称，而现在您正在阅读的描述文本，您应该在这里提供对您的模块功能的良好简短说明。

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

以下是一个模板，您应理想地将其包含到您的 readme.md 中，以符合模块标准并帮助他人使用您的模块。

准备此模块供您使用的步骤

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

要求

• 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的config API，提供一个示例配置是一个好主意，这将使模块能够直接运行，并展示用户可能的配置选项。

尽可能提供yaml代码示例。

Page:
  config_option: true
  another_config:
    - item1
    - item2
  

维护者

• 联系人员 person@emailaddress.com
• 另一位维护者 maintain@emailaddress.com

问题追踪器

问题在该存储库的问题部分进行跟踪。在提交问题之前，请阅读现有的问题以确保您的问题具有唯一性。

如果问题看起来像是新出现的错误

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

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

开发和贡献

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