add comments

Author: Feiyang1

scripts/exp/prepare-firestore-for-exp-release.ts

@@ -24,7 +24,18 @@ const writeFile = promisify(_writeFile);
 const readFile = promisify(_readFile);
 const packagePath = `${projectRoot}/packages/firestore`;
 
-// Prepare @firebase/firestore, so scripts/exp/release.ts can be used to release it
+//
+/**
+ * Transform package.json in @firebase/firestore so that we can use scripts/exp/release.ts to release Firestore exp.
+ * It does following things:
+ * 1. Update package.json to point to exp binaries
+ * 2. Update version to '0.0.800', the version number we choose for releasing exp packages
+ *    (8 stands for v8, 800 to avoid conflict with official versions).
+ *    The release script will append commit hash to it and release the package with that version.
+ *    e.g. 0.0.800-exp.fe85035e1
+ * 3. Replace peerDependencies with the exp version, so the release script can match and update them to the correct version.
+ * 4. Replace imports with imports from exp packages in typing files.
+ */
 export async function prepare() {
   // Update package.json
   const packageJson = await readPackageJson(packagePath);