准备发布


在你准备好发布自己的学习路径之前,请确保已完成以下任务。

申请学习路径图标

为了给网站设计图标,请在 exercism/website-icons 仓库中新建一个 issue,并回答以下问题:

  • 这门语言有官方 logo 吗?如果有:
    • 请附上一个示例链接
    • 请列出署名要求,以及使用该 logo 所获得的权利
  • 这门语言有非官方 logo 吗?如果有:
    • 请说明人们使用该非官方 logo 的方式
    • 请附上一个示例链接
    • 请列出该 logo 的署名要求

添加学习路径文档

添加以下学习路径文档:

  • docs/ABOUT.md:对这门语言的简短介绍。
  • docs/INSTALLATION.md:说明学生需要安装什么,才能使用 CLI 在自己的本地系统上做这条学习路径上的练习。
  • docs/LEARNING.md:学习资源的链接。
  • docs/RESOURCES.md:实用资源的链接。
  • docs/TESTS.md:说明与在这条学习路径上运行测试相关的一切内容。

这些文档能帮助学生上手这条学习路径,并了解这条学习路径及其语言。 更多信息请参见文档说明。

添加练习文档

添加以下练习文档:

  • exercises/shared/.docs/help.md:包含本学习路径特有的帮助获取说明
  • exercises/shared/.docs/tests.md:包含本学习路径特有的测试运行说明

添加代码片段

在 docs/SNIPPET.txt 文件中添加一段代码片段。 这段片段能让人直观感受这门语言的语法是什么样子。 更多信息请参见文档说明。

更新元数据

学习路径的元数据定义在 config.json 文件中。 应更新以下属性:

  • language:这条学习路径的语言(例如 "C#")。长度必须 <= 255
  • slug:学习路径语言的小写、kebab-case 形式字符串(例如 "csharp")。长度必须 <= 255
  • blurb:对这门语言的简短描述。长度必须 <= 400
  • online_editor:一个描述在线编辑器所用设置的对象:
    • indent_style:"space" 或 "tab"
    • indent_size:缩进大小,为整数(例如 4)
    • highlightjs_language:Highlight.js 的语言标识符(参见标识符完整列表)。如果没有 Highlight.js 支持,可以省略该字段。
  • key_features:这门语言的关键特性,简要描述其最重要的特性。更多信息请查看关键特性文档。
  • tags:定义适用于这条学习路径的标签,以便在网站上搜索到它。更多信息以及支持的标签列表,请查看标签文档。