easyengine / scaffold-command
使用 README.md 构建EasyEngine命令
dev-develop
2019-01-01 13:28 UTC
This package is auto-updated.
Last update: 2024-08-29 05:30:45 UTC
README
使用
ee scaffold package-readme <dir> [--force]
根据 EE 包的 composer.json 文件创建 README.md,包括使用、安装和贡献说明。在项目开始时以及每次更改使用文档时运行此命令。
这些特定命令的文档是基于 composer.json 中的 'extra' -> 'commands' 生成的。例如,此包的 composer.json 包含
{
"name": "easyengine/scaffold-command",
// [...]
"extra": {
"commands": [
"scaffold package-readme"
]
}
}
选项
<dir>
Directory path to an existing package to generate a readme for.
[--force]
Overwrite the readme if it already exists.
贡献
感谢您主动为该项目做出贡献。
贡献不仅限于代码。我们鼓励您以最适合您能力的方式做出贡献,例如编写教程、在当地聚会中演示、帮助其他用户解答支持问题或修订我们的文档。
报告错误
认为您找到了错误?我们很高兴您能帮助我们修复它。
在创建新问题之前,您应该 搜索现有问题 以查看是否已存在对该错误的解决方案,或者它是否已在较新版本中修复。
一旦您进行了一些搜索并发现没有为您的错误打开或修复的问题,请 创建一个新问题。请尽可能提供详细信息,并在可能的情况下提供清晰的复现步骤。
创建拉取请求
想要贡献新功能?请首先 创建一个新问题 以讨论该功能是否适合项目。
支持
GitHub 问题是针对一般支持问题的,但您还可以尝试其他途径: https://easyengine.io/support/
此 README.md 是使用 ee scaffold package-readme (文档)从项目的代码库动态生成的。要建议更改,请提交针对代码库相应部分的拉取请求。