Improve Documentation for Attendee List Generation Scripts.
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 新手友好度
- 55/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- javascript
调研方向
从 util/README.md 开始，将其中的说明与 util/create-attendee-handle-map.js 和 util/map-handles-to-catchup-attendees.js 进行比较。记录这些脚本支持 Attendee List Generation、运行它们的顺序以及运行它们时所在的目录。当 README 清楚地说明如何为 summary/sessions 中的会话生成 attendees.adoc 文件时，即表示完成。
由索引模型根据 Issue 内容生成。
描述
- The https://github.com/OurTechCommunity/catchup/blob/main/util/README.md file documents the usage of the two scripts https://github.com/OurTechCommunity/catchup/blob/main/util/create-attendee-handle-map.js and https://github.com/OurTechCommunity/catchup/blob/main/util/map-handles-to-catchup-attendees.js that aid in generating the
attendees.adocfile for every session insummary/sessions. - The issue is that the
util/README.mddocument isn't very explicit in mentioning- What feature the two scripts are meant for (the Attendee List Generation feature).
- The order of running the scripts.
- From where (which directory) the scripts have to be run from.
- Adding this to the documentation would make it easier to use the Attendee List Generation feature.
Cc: @tusharnankani
- 主要语言
- JavaScript
- 星标
- 19
- 派生
- 18
- 平均合并
- 3 天 6 小时
- 30 天内合并 PR
- 3
环境准备
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
OurTechCommunity/catchup 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
OurTechCommunity/catchup#347 · 4 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 55/100
OurTechCommunity/catchup#303 ·
-
documentation
难度 2/5 1-3 小时 新手友好度 38/100
OurTechCommunity/catchup#258 ·
-
难度 2/5 1-3 小时 新手友好度 48/100
OurTechCommunity/catchup#184 · 2 条评论 ·
-
CI/CD good first issue
难度 1/5 1 小时以内 新手友好度 55/100
OurTechCommunity/catchup#172 · 1 条评论 ·
查看 OurTechCommunity/catchup 的全部 Issue
相似的 Issue
-
Complexity: Small P-Feature: Projects page ready for merge team role: back end/devOps role: front end size: 0.25pt
难度 1/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 67/100
bellingcat/toolkit#905 ·
-
self-care self-care:docs-build-time-investigator
难度 2/5 半天 新手友好度 76/100
githubnext/gh-aw-cao#14191 ·
维护者通常 1 天内回复
-
effort:low impact:medium RAG status: auto-triaged
难度 2/5 1-3 小时 新手友好度 84/100
mastra-ai/mastra#25229 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 88/100
sugarlabs/musicblocks#8984 ·
维护者通常 1 天内回复