Update instructions for blueprint.md#10089
Conversation
Summary of ChangesHello, 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 Highlights
🧠 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
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
| * **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. |
5888b17 to
cfc4de3
Compare
Update instructions for blueprint.md