Add an experimental doc as a repository for AI agent knowledge #1734
Conversation
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
This commit reformats the Jules.md AI guide to ensure all narrative text is wrapped to a maximum of 80 characters per line. This change improves readability, especially in environments or editors with limited horizontal space, and aligns with common markdown style preferences. Code blocks have been preserved with minimal changes to maintain their integrity.
This commit updates Jules.md, the AI agent guide, with additional
context and details sourced from the official Firebase C++ online
documentation.
Key enhancements include:
- **Introduction**: Added a link to the Firebase library support by
platform table and a note on the open-source structure of the C++ SDKs
(desktop vs. mobile).
- **Setup Commands**:
- Clarified iOS setup to include linking .framework files alongside
pods.
- Added a new "Desktop Platform Setup Details" subsection, covering:
- Conversion of iOS `GoogleService-Info.plist` to
`google-services-desktop.json` using the provided Python
script.
- Search order for desktop configuration files.
- Common system library dependencies for Windows, macOS, and
Linux desktop builds.
- **API Surface**:
- Clarified that `firebase::auth::User` objects are typically
obtained from `firebase::auth::AuthResult` after successful
authentication operations.
- **Best Practices**:
- Added a "Platform-Specific Considerations" subsection detailing:
- The REST-based nature of the Realtime Database C++ SDK on
desktop and the consequent need for server-side indexing for
`OrderByChild()` queries.
- Awareness of iOS method swizzling used by some Firebase
products.
These additions provide more comprehensive guidance for you,
particularly regarding platform-specific nuances and SDK architecture.
The document maintains an 80-character line wrap.
a-maurice
approved these changes
Jun 18, 2025
…alization and Future management.
This update incorporates further feedback from you into Jules.md:
1. **Clarified Analytics Initialization:**
The "API Surface" -> "Initialization" section now specifies that
Firebase Analytics uses a different initialization pattern
(`firebase::analytics::Initialize(app)`) compared to the common
`GetInstance(app, ...)` pattern of other services. It also notes
that Analytics functions are typically called globally.
2. **Added Future Lifecycle Management Guidance:**
A new point in "Best Practices" -> "Resource Management" emphasizes
the importance of ensuring `Future` objects complete their course
(e.g., via `OnCompletion` or by checking results) to prevent
potential issues with operations not finalizing or resources not
being cleaned up promptly.
These changes provide more nuanced guidance for interacting with the Firebase C++ SDK.
github-actions
bot
added
the
tests: in-progress
Integration test with FLAKINESS (succeeded after retry)Requested by @jonsimantov on commit 5ea2a16
Add flaky tests to go/fpl-cpp-flake-tracker |
github-actions
bot
added
the
tests: succeeded
firebase-workflow-trigger
bot
removed
the
tests: in-progress
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.
Description
This experimental document is meant for consumption by AI agents and will be maintained by them as a way to remember repo standards and conventions across tasks.
Testing
Type of Change
Place an
xthe applicable box:Notes
Release Notessection ofrelease_build_files/readme.md.