Skip to content

Update instructions for blueprint.md#10089

Merged
christhompsongoogle merged 2 commits into
mainfrom
backendjson
Mar 13, 2026
Merged

Update instructions for blueprint.md#10089
christhompsongoogle merged 2 commits into
mainfrom
backendjson

Conversation

@christhompsongoogle
Copy link
Copy Markdown
Contributor

Update instructions for blueprint.md

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the system instructions by providing a comprehensive guide to understanding backend.json. The update clarifies its function as a data structure blueprint, distinguishing it from deployment scripts or live cloud resource configurations, and explains its contents and intended usage to prevent misinterpretation.

Highlights

  • Clarified backend.json purpose: A new section was added to the system instructions template, providing a detailed explanation of backend.json. This clarifies its role as a blueprint for data structure, distinguishing it from deployment artifacts or live cloud resource configurations.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • templates/firebase-studio-export/system_instructions_template.md
    • Added a new section titled "Understanding backend.json" to clarify its purpose and usage.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds documentation about backend.json to the system instructions template. The added information is clear and helpful for understanding the role of backend.json. However, the pull request title and description refer to blueprint.md, which is confusing as the changes are about backend.json. I've also added a suggestion to improve clarity in the documentation itself by avoiding the term 'blueprint' to describe backend.json, as a file named blueprint.md with a different purpose is also referenced in this document.


- `docs/backend.json` if it exists, is a description of the data structure of this application used by the model at the time it was generated.
- The `backend.json` file is **NOT** a deployment script, a configuration file, or a source of truth for live cloud resources.
* **It is a BLUEPRINT, not the building.** It describes a *plan* for the data structure. It does **NOT** represent the currently deployed state. Think of it as an architect's drawing, not the physical house.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To avoid potential confusion with docs/blueprint.md (mentioned on line 12), consider rephrasing this line to avoid using the word 'BLUEPRINT'. Using a different term will help distinguish the concept of backend.json from the blueprint.md file.

Suggested change
* **It is a BLUEPRINT, not the building.** It describes a *plan* for the data structure. It does **NOT** represent the currently deployed state. Think of it as an architect's drawing, not the physical house.
* **It is an architectural plan, not the building.** It describes a *plan* for the data structure. It does **NOT** represent the currently deployed state. Think of it as an architect's drawing, not the physical house.

@christhompsongoogle christhompsongoogle enabled auto-merge (squash) March 13, 2026 18:48
@christhompsongoogle christhompsongoogle merged commit 4d4a186 into main Mar 13, 2026
47 checks passed
@christhompsongoogle christhompsongoogle deleted the backendjson branch March 13, 2026 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants