Modernize backend README to mirror copilot-instructions and actual package config#55
Merged
Merged
Conversation
Copilot created this pull request from a session on behalf of
ernysans
June 11, 2026 16:17
View session
ernysans
marked this pull request as ready for review
June 11, 2026 16:17
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
README.MDhad drifted from the repository's actual configuration and lacked an explicit map of the AI-assisted engineering workflow defined in.github/copilot-instructions.md. This rewrite realigns the docs withpackage.json,firebase.json, and the ESLint/Vitest configs, and adds the contributor-facing rules for human + Copilot collaboration.Restructured into five core sections
>=22target runtime, and how helpers integrate with Cloud Functions, Firestore, Storage, RTDB, Pub/Sub, BigQuery, andsharp.src/,test/,functions/src/…) plus a> [!CAUTION]alert enforcing the/libbuild-output blacklist (never edit, never use as context; refresh only vianpm run build).npm install,build/build:watch, andfirebase emulators:startwith the exact ports fromfirebase.json.npm test/test:watch/npx vitest, side-effect-free mocking rules (vi.mock/vi.hoisted,firebase-functions-test, emulator/stub data access), and the lint + build + test gate..github/copilot-instructions.md: strict typing, Google JSDoc standards, URL preservation, async/await, thin triggers, validate-before-write.Accuracy fixes
package.json:libphonenumber-js ^1.13.5,eslint ^10.4.1,vitest ^4.1.8.status, which is not re-exported fromsrc/index.ts.Preserved
Documentation-only change; no source, config, or scripts were modified.