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 中要求模块
• 如果您需要构建 JS 客户端
  • 请确保使用 composer install --prefer-source 而不是默认的 --prefer-dist 安装 vendor/silverstripe/admin。您可能需要首先从 vendor 文件夹中删除模块。
  • 在模块和 vendor/silverstripe/admin 中安装第三方依赖项，通过在两个位置运行 yarn install
• 开始开发您的模块！

要求

• 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模块。

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

开发和贡献

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