贡献指南
Cromwell是一个开源项目，我们热忱欢迎社区为代码和文档做出贡献。以下是一些添加文档的指南，以及我们最需要帮助的领域建议。
首先，以下是一些有用的链接：
- Cromwell文档: cromwell.readthedocs.io
- Github源码: github.com/broadinstitute/cromwell
- 基于ReadTheDocs构建：readthedocs.org/projects/cromwell
- 如何本地构建和查看文档：mkdocs.readthedocs.io
写作技巧
- 保持清晰、准确且简洁。
- 将最重要的信息放在首位。
- 使用第二人称，用“你”代替“用户”。
- 不使用被动语态（所有动作都有明确的执行者）。
- 链接到原始来源，不要重复文档内容。
格式化
文档采用Markdown格式编写。点击此处查看Github的Markdown指南，点击此处获取更多MkDocs使用技巧。
样式设置
链接：
- 绝对路径:
[link text](www.destinationURL.com)示例:[Broad Institute](www.broadinstitute.org)会生成这个链接 Broad Institute. - 相对路径：
[link text](Destination_Page)，其中Destination_Page是不带.md扩展名的文件名
示例：[How to use the Cromwell CLI](CommandLine)会生成这个链接 How to use the Cromwell CLI。 - 锚点链接:
[anchor text](../Path/To/Page#Anchor)
示例:[HPC文件系统](backends/HPC#filesystems)生成此链接 HPC filesystems.
代码:
- 要为代码中的单词添加样式，请在单词前后使用反引号（`）。
示例： `file.json` 会生成file.json。 - 要格式化代码块，请在代码块前后使用三个反引号（```）。
示例：
```
workflow myWorkflow {
call myTask
}
```
将生成如下代码块
workflow myWorkflow {
call myTask
}
- 要使用语法高亮功能，请在开头的三个反引号(```)后指定语言。
示例：
```json
{
"MyWorkflow.MyTask.VariableTwo": "Variable2"
}
```
会生成如下代码块
{
"MyWorkflow.MyTask.VariableTwo": "Variable2"
}
镜像
- Relative:
- 示例：
生成此图片
- 示例：
- Absolute:
- 示例：
生成此图片
- 示例：
左侧菜单：
要在菜单中添加或删除项目，请编辑Cromwell中的mkdocs.yml。
常见问题
为什么我的文档没有显示？
-
您的拉取请求(PR)是否已合并？
如果尚未合并，请礼貌地请求团队进行合并。一旦您的PR合并到develop分支，将触发自动构建流程。 -
构建完成了吗？
Check build status here. -
您是否已将文件添加到YAML配置中？
如果还没有，点击此处添加。