Skip to content

Conversation

@LiZhenCheng9527
Copy link
Contributor

add PR and issue template for agentCube
include:

  • good first issue
  • bug report
  • enhancement request
  • question
  • PR template

Signed-off-by: LiZhenCheng9527 <lizhencheng6@huawei.com>
@volcano-sh-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @LiZhenCheng9527, 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 agentCube repository's contribution guidelines by introducing a suite of standardized templates for both issues and pull requests. These templates are designed to improve the clarity, consistency, and completeness of community interactions, making it easier for users to report problems, propose features, ask questions, and for contributors to submit well-documented code changes.

Highlights

  • Bug Report Template: Introduced a structured template for reporting bugs, ensuring all necessary information is captured, such as what happened, expected behavior, reproduction steps, and environment details.
  • Enhancement Request Template: Added a template to guide users in suggesting new features or improvements, prompting for desired additions and their necessity.
  • Good First Issue Template: Created a template to help maintainers define and publish issues suitable for new contributors, outlining task descriptions, solutions, and participation guidelines.
  • Question Template: Provided a template for users to ask questions, encouraging detailed inquiries, personal thoughts on the question, and environment information.
  • Pull Request Template: Implemented a comprehensive template for PR submissions, covering PR type, purpose, issue linking, special notes for reviewers, and a dedicated release notes section.

🧠 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.

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
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 several useful templates for issues and pull requests, which will help standardize contributions. The templates are well-structured. I've found a few minor typos and a configuration error in the frontmatter of one of the issue templates. Please see my detailed comments for suggestions.

Signed-off-by: LiZhenCheng9527 <lizhencheng6@huawei.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants