Code a tool to update a JSON reference file
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- python
- 领域
- documentation, tooling
调研方向
首先阅读 repository 的文档生成流程，并确定 JSON 参考文档在哪里生成。确定应如何提供和保留代码示例、教程链接和参考资料等额外字段，然后定义更新生成的参考文档的验收标准，同时避免使源代码变得杂乱。
由索引模型根据 Issue 内容生成。
描述
To make the docs maker as flexible as possible, we'd like to support having JSON keys or metadata on top of the one generated by the tool. That is to say, extra fields that may not be in the tool, like code examples, links to tutorials, references... extra information that would clutter the source code.
- 主要语言
- Python
- 星标
- 297
- 派生
- 26
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
我们还没有检查这个项目的环境配置文件。先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
GDQuest/gdscript-docs-maker 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 38/100
GDQuest/gdscript-docs-maker#95 · 4 条评论 · 1 个 reaction ·
-
难度 2/5 1-3 小时 新手友好度 45/100
-
enhancement
难度 4/5 3-5 天 新手友好度 35/100
-
enhancement
难度 2/5 1-3 小时 新手友好度 55/100
GDQuest/gdscript-docs-maker#86 · 1 个 reaction ·
-
bug
难度 3/5 1-2 天 新手友好度 35/100
GDQuest/gdscript-docs-maker#71 · 3 条评论 ·
查看 GDQuest/gdscript-docs-maker 的全部 Issue
相似的 Issue
-
pydanty:is-working
难度 2/5 1-3 小时 新手友好度 78/100
pydantic/pydantic-ai#8843 ·
维护者通常 1 天内回复
-
breaking change enhancement server
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
needs-triage
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复