gbdev/pandocs

LOW and HIGH terms might be confusing in SGB docs

Open

#375 创建于 2021年10月10日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Markdown (134 fork)auto 404
contentgood first issue

仓库指标

Star
 (775 star)
PR 合并指标
 (PR 指标待抓取)

描述

"LOW" and "HIGH" are used to refer to signals, but a software developer may not have the necessary background to understand what those mean. They should be at least explained in an info box at the top (as per the style guide), and maybe replaced throughout the document where it makes sense to do so.

贡献者指南

研究方向
查阅 pandocs 风格指南中关于解释 LOW 和 HIGH 等术语的约定。找出文档中所有未加解释就使用这些术语的地方。在每个相关部分的顶部添加信息框，并在适当的地方替换为更清晰的术语。
技术栈
无
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75