docs(firestore-send-email): restructure the kit README to match the firestore-bigquery-export kit README

オープン
#3,315 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 8 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
55/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
typescript
領域
documentation

調査の方向性

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 の本文から書いたものです。

説明

documentation kits

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:migrate and firebase ext:export --mode functions.
  • Region: a subsection under Differences. Fold DATABASE_REGION now decides where the function runs into 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時間
マージ済み PR(30日)
28

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

firebase/extensions のほかの issue

firebase/extensions の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。