Add a hook generator
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- php
- 领域
- documentation, tooling
调研方向
首先阅读 generate-hook-docs.php,了解当前脚本如何发现源文件并生成 hook 文档。确定捕获所有源文件并为单个文件、actions 和 filters 生成独立页面的范围;当生成器根据源代码创建预期的文档页面时,即表示完成。
由索引模型根据 Issue 内容生成。
描述
Currently we are using an old script that doesn't capture all files from our source code.
You can find the current script in https://github.com/woocommerce/code-reference/blob/trunk/generate-hook-docs.php
We could take this opportunity to create a documentation for hooks generating several pages for individual files and types like actions and filters.
- 主要语言
- Twig
- 星标
- 17
- 派生
- 12
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
woocommerce/code-reference 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 45/100
woocommerce/code-reference#20 · 1 个 reaction ·
-
难度 4/5 3-5 天 新手友好度 42/100
woocommerce/code-reference#19 · 1 个 reaction ·
-
难度 4/5 3-5 天 新手友好度 25/100
查看 woocommerce/code-reference 的全部 Issue
相似的 Issue
-
docs help wanted
难度 1/5 1-3 小时 新手友好度 75/100
-
难度 1/5 1-3 小时 新手友好度 72/100
MattA-Official/vwmcp#20 ·
-
documentation
难度 2/5 1-3 小时 新手友好度 74/100
cosimochellini/one-piece-zero-spoiler#551 ·
维护者通常 1 天内回复
-
documentation good first issue
难度 1/5 1-3 小时 新手友好度 88/100
undergroundrap/hatchling#15 ·
-
enhancement
难度 2/5 1-3 小时 新手友好度 68/100
Albert-Weasker/niubigeo#205 ·
维护者通常 1 天内回复