Refine Schemas Code Contributor Agent Definition#586
Refine Schemas Code Contributor Agent Definition#5861012Charan wants to merge 3 commits intomeshery:masterfrom
Conversation
Signed-off-by: 1012Charan <charanvengala@gmail.com>
Summary of ChangesHello @1012Charan, 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 significantly enhances the definition of the Highlights
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 significantly refines the schemas code contributor agent definition, providing a much more detailed and comprehensive guide. The new code-contributor.md is well-structured and covers the essential workflows and constraints for contributing to the meshery/schemas repository.
I've identified a couple of inaccuracies in the instructions that could lead to confusion or incorrect actions by the agent. My feedback includes a correction for a redundant build command and a clarification on the process for updating TypeScript exports, which is currently incomplete. Addressing these points will make the agent definition even more robust and reliable.
.github/agents/code-contributor.md
Outdated
| 6. Update `typescript/index.ts`: | ||
| ```typescript | ||
| import { components as NewComponents } from "./generated/v1beta1/<construct>/<Construct>"; | ||
| export type <Construct> = NewComponents["schemas"]["<Construct>Definition"]; | ||
| ``` |
There was a problem hiding this comment.
The instructions for updating typescript/index.ts are incomplete and could lead to an incorrect public API for the TypeScript package. The current example misses importing the schema file, exporting it, and does not mention adding the type to a versioned namespace.
A more accurate set of instructions should guide the agent to perform these actions, as shown in CONTRIBUTING.md and the existing typescript/index.ts file.
Here is a more complete example of the changes needed in typescript/index.ts that should be reflected in the agent's instructions:
// 1. Add new imports for the construct
import { components as NewComponents } from "./generated/v1beta1/<construct>/<Construct>";
import NewConstructSchema from "./generated/v1beta1/<construct>/<Construct>Schema";
// ... other imports
// 2. Add the new schema to the main export block
export {
// ... existing schemas
NewConstructSchema,
};
// ...
// 3. Add the new type to the versioned namespace
export namespace v1beta1 {
// ... existing types
export type <Construct> = NewComponents["schemas"]["<Construct>Definition"];
}Please update the agent definition to reflect this more detailed process.
.github/agents/code-contributor.md
Outdated
| ## Build System | ||
|
|
||
| ```bash | ||
| make setup && npm install # Install all dependencies (first time) |
There was a problem hiding this comment.
The make setup command already includes npm install, so running npm install again is redundant. The instruction should be simplified to just make setup to avoid confusion and unnecessary work for the agent.
| make setup && npm install # Install all dependencies (first time) | |
| make setup # Install all dependencies (first time) |
Signed-off-by: 1012Charan <charanvengala@gmail.com>
97c9694 to
e1f1df1
Compare
.github/agents/code-contributor.md
Outdated
|
|
||
| # Meshery Schemas Code Contributor | ||
|
|
||
| You are an expert-level software engineering agent specialized in contributing to **meshery/schemas**, the central repository for Meshery's schema definitions. This repository follows schema-driven development, generating Go structs and TypeScript types from OpenAPI specifications. Changes made here propagate across Meshery Server, UI, and Cloud. |
There was a problem hiding this comment.
Meshery CLI, MeshKit, Meshery Adapters... other ecosystem components.
7bf0232 to
e1f1df1
Compare
Signed-off-by: 1012Charan <charanvengala@gmail.com>
Description
Refines the existing schemas agent into a complete, blueprint-level definition in
.github/agents/code-contributor.md.Changes
models/,typescript/generated/,dist/,openapi/build/).v1alpha1/coretypes andx-orderfor field ordering.Replaces the previous, incomplete
schemas-code-contributor.mdagent definition.This PR fixes #583
Signed commits