Autogen per-test docs for discoverability
维护者通常 14 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- go, yaml
- 领域
- documentation, testing
调研方向
首先检查提议的 YAML schema 和示例入口点 tests/csapi/rooms_state_test.go:TestRoomCreationReportsEventsToMyself。确定 sytests 如何为自动化文档公开名称、行为、变体和测试领域。完成的标准是生成的文档能够列出这些详细信息，并将每个条目链接到其测试路径。
由索引模型根据 Issue 内容生成。
描述
While working on importing sytests, i found myself ctrl-shift-f-ing on keywords to see what tests already existed to see if a sytest would fit that file, however, I think that this displays some poor test discoverability.
However, when i was documenting some sytests (and their behaviour), i came upon something like the following format;
sytest:
- name: "Non-present room members cannot ban others"
type:
- power_level
- ban
desc:
When a user does not exist in a room, but has powerlevels there, it should not be able to ban users.
variants:
- user has never entered the room
- user has left the room
- user has been kicked while ban is sent out
- user server has been ACL-d
- name: "New federated private chats get full presence information (SYN-115)"
# ...
I think it would be useful to programmatically document (and maybe link) these tests, so that a quick glance can see which ones exist, what it does, what variants of behaviour it's also testing, and also in which "areas" of testing matrix it exists.
For a final variant of above schema, i think adding a path (something like tests/csapi/rooms_state_test.go:TestRoomCreationReportsEventsToMyself) would help auto-identify the corresponding function.
- 主要语言
- Go
- 星标
- 101
- 派生
- 72
- 平均合并
- 11 天 5 小时
- 30 天内合并 PR
- 7
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
matrix-org/complement 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
matrix-org/complement#900 · 1 条评论 ·
维护者通常 14 天内回复
-
难度 5/5 一周以上 新手友好度 45/100
matrix-org/complement#938 ·
维护者通常 14 天内回复
-
New tests for MSC4354 Sticky Events可能重新可做 @reivilibre 于 31 天前认领，目前没有进行中的 PR。 未关闭
matrix-org/complement#925 · 已指派 1 人 ·
维护者通常 14 天内回复
-
难度 3/5 1-2 天 新手友好度 52/100
matrix-org/complement#901 · 1 条评论 ·
维护者通常 14 天内回复
-
难度 3/5 1-2 天 新手友好度 55/100
matrix-org/complement#899 ·
维护者通常 14 天内回复
查看 matrix-org/complement 的全部 Issue
相似的 Issue
-
fix(handlers): explicitly set Content-Type header in static Index handler可能已有人在做 @kage-zero 今天认领。 未关闭
难度 1/5 1 小时以内 新手友好度 85/100
维护者通常 1 天内回复
-
Quick Open: restore dependency-directory exclusions in filesystem fallback可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
eugenioenko/ttt#1206 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
open-policy-agent/opa#9426 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
rorkai/App-Store-Connect-CLI#3192 ·
维护者通常 1 天内回复
-
t:urlDecodeUni does not map U+3002 and U+FF61 to a dot, unlike ModSecurity可能已有人在做 @fzipi 今天认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复