docs(firestore-send-email): restructure the kit README to match the firestore-bigquery-export kit README
维护者通常 8 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 55/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- typescript
调研方向
Read kits/firestore-send-email/README.md alongside kits/firestore-bigquery-export/README.md at the referenced commit to compare their structure. Wait for #3309 to merge and #3300 to be done, then reorganize the send-email README to follow the listed section order and incorporate their content. Done when the requested sections are present, including the missing migration and failure handling guidance, with Provisioning included only if it applies.
由索引模型根据 Issue 内容生成。
描述
firestore-send-email kit README. Priority: low. Do this last, after the other sub-issues of #3290 have landed.
What
Restructure kits/firestore-send-email/README.md so it is similar in structure and length to kits/firestore-bigquery-export/README.md. At kits @ 3ded546a, the FBE README is 418 lines and 2,450 words; this one is 316 lines and 2,219 words.
Follow the FBE section order: Install, Required IAM, Usage, Deploy, Configuration, Multiple instances, Events, Provisioning, Failure handling, Migrating from the extension, Differences from the extension (including a Region subsection), API surface, Reporting bugs, License.
Sections this README is missing:
- Failure handling: what happens when a run fails, and how to find out.
- Migrating from the extension:
firebase ext:migrateandfirebase ext:export --mode functions. - Region: a subsection under Differences. Fold
DATABASE_REGION now decides where the function runsinto it. - Provisioning: only if it applies to this kit.
When
Wait until #3309 (which edits this README) has merged. Then fold its content into the new structure rather than rewriting it.
Also fix the wrong README and CHANGELOG statements listed in #3300, which was closed in favour of this issue.
- 主要语言
- TypeScript
- 星标
- 979
- 派生
- 434
- 平均合并
- 10 天 8 小时
- 30 天内合并 PR
- 28
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
firebase/extensions 的其他 Issue
-
kits parity type: bug
难度 2/5 1-3 小时 新手友好度 65/100
firebase/extensions#3303 ·
维护者通常 8 天内回复
-
kits parity type: bug
难度 2/5 1-3 小时 新手友好度 78/100
firebase/extensions#3301 ·
维护者通常 8 天内回复
-
kits parity type: bug
难度 2/5 1-3 小时 新手友好度 76/100
firebase/extensions#3296 ·
维护者通常 8 天内回复
-
kits parity type: bug
难度 2/5 1-3 小时 新手友好度 78/100
firebase/extensions#3294 ·
维护者通常 8 天内回复
-
kits parity type: bug
难度 2/5 1-3 小时 新手友好度 75/100
firebase/extensions#3291 ·
维护者通常 8 天内回复
查看 firebase/extensions 的全部 Issue
相似的 Issue
-
bot:ai-assisted component:platform-js status:untriaged
难度 2/5 1-3 小时 新手友好度 78/100
midnightntwrk/platform-js#69 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
Picolab/pico-engine#668 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
ai-driven-qa bug claude Cosmetic
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
needs verification
难度 2/5 1-3 小时 新手友好度 64/100
维护者通常 13 天内回复