LabEx Author Guide home page
Search...
⌘K
联系我们
LabEx
LabEx
Search...
Navigation
进阶
新建 Issue
作者手册
用户手册
基础
设计概览
实验和挑战
Skill Tree
开始制作
如何提交
在线测试
修订提交
工具推荐
进阶
如何 Review
新建 Issue
风格统一性规范
其他
成为作者
学术道德
On this page
Issue 模板
Issue 素材
进阶
新建 Issue
所有的内容,都是基于 Issue 制作的,Issue 注明了 Lab/Challenge 的基本信息和制作所需素材。你可以自由认领未分配的 Issue,或者开启新的 Issue。
Issue 模板
点击 New Issue 后,你可以看到相应的 Issue 模板。
选择相应的模板,填写相应的信息。
请注意,以上:
❶ Issue 标题:请参考已有的 Issue 标题格式,如:
lab-hello-world
。取标题要遵守简小原则,即尽量简单(一般不超过 5 个单词),且标题的范围不要太大(因为你的内容一般覆盖不了大范围标题)。
❷ Issue 信息:Title 需要使用 Title Case。环境需要参考
Backend
说明。
❸ Issue 素材:其中 Lab 至少需要提供正文内容,Challenge 至少需要提供正文内容和检测脚本。
❹ Skills ID:需要参考
Skill Tree
说明,从 Skill Tree 中列出相应的 Skill。
❺
特别注意:
默认情况下 Issue 会绑定难度标签 Beginner,如果你认为这个 Issue 需要更高的难度,请自行修改。
默认 Issue 会被 Assign 给 huhuhang 进行 Review。
审核通过后
我们会去掉 Pending Review 的标签,并将 Assignees 留空,开放给大家自由认领。
如果你想要自己制作这个 Issue,请在 Assignees 中添加自己,审核通过后 Issue 会被 Assign 给你。
Issue 素材
Issue 素材是指 Issue 中的正文内容和检测脚本(可选)。你可以参考一些合格的 Issue:
https://github.com/labex-labs/scenarios/issues/290
https://github.com/labex-labs/scenarios/issues/282
https://github.com/labex-labs/scenarios/issues/75
注意事项:
请使用 Markdown 格式添加 Issue,方便作者直接拷贝使用,减少格式调整的时间。
素材的内容要规范,正文、检测脚本、注意事项等可以分多条评论添加,要以清晰的结构呈现给作者,方便有兴趣制作该 Issue 的作者快速理解。
素材的内容可以使用 AIGC 的方式生成,但请务必快速过一遍,避免出现明显的错误,误导作者。
总之,素材的目的是让制作该 Issue 的作者快速开始。我们期望作者只需要
重组、测试
素材内容,将内容整理成 LabEx 要求的结构。大部分情况下不需要作者自行补充内容,这就给 Issue 的素材提出了更高的要求。
Was this page helpful?
Yes
No
如何 Review
风格统一性规范
Assistant
Responses are generated using AI and may contain mistakes.