Skip to content

Conversation

@LiZhenCheng9527
Copy link
Contributor

Added CONTRIBUTING.md for agentCube.

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 introduces a CONTRIBUTING.md file, establishing clear guidelines and expectations for community members who wish to contribute to the AgentCube project. Its purpose is to standardize the contribution process, from initial setup and development practices to code review and merging, thereby fostering a more organized and efficient collaborative environment.

Highlights

  • New Contribution Guidelines: A new CONTRIBUTING.md file has been added to the repository, providing comprehensive guidelines for contributors.
  • Detailed Workflow: The document outlines a detailed contribution workflow, covering steps from picking tasks and setting up the development environment to commit conventions, pull request submission, and code review processes.
  • Standards and Expectations: It clearly defines coding standards, testing guidelines, documentation expectations, project governance, and available tooling to ensure consistency and quality in contributions.

🧠 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 introduces a CONTRIBUTING.md file, which is a great step towards encouraging community contributions. The guide is well-structured and comprehensive, borrowing from the Volcano project's guide. I've provided a few suggestions to improve clarity and fix potentially broken or confusing references, such as the Slack link, the OWNERS file link, and the security contact email. Overall, this is a solid contribution.

* Join the conversation on GitHub:
* [Issues](https://github.com/volcano-sh/agentcube/issues) for bug reports and feature requests
* [Discussions](https://github.com/volcano-sh/agentcube/discussions) for design questions and ideas
* Chat with maintainers via Slack (link in the project README)
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

This line refers to a Slack link in the project's README.md, but the file does not currently contain one. This could be confusing for new contributors. Please consider adding the Slack invitation link directly to this document or updating the README.md accordingly.


## 🧭 Governance and Ownership

* Maintainers are listed in the top-level [`OWNERS`](./OWNERS) file and `OWNERS` files in subdirectories
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The link to the OWNERS file is a relative link. This is great for navigating within the repository, but it will be a broken link until the OWNERS file is created. Please ensure this file exists at the root of the project to guide contributors on code ownership.


## 🔐 Security Reporting

* For sensitive issues, email volcano-security@googlegroups.com instead of filing a public issue
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The email provided is for the parent project, Volcano. To avoid any confusion, it would be beneficial to clarify that the Volcano security team also handles security reports for AgentCube.

Suggested change
* For sensitive issues, email volcano-security@googlegroups.com instead of filing a public issue
* For sensitive issues, email the Volcano security team at volcano-security@googlegroups.com instead of filing a public issue


### 4. Develop with Tests

* Follow Go best practices and respect existing module structure under `pkg/` and `cmd/`
Copy link
Member

Choose a reason for hiding this comment

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

should we add some links what is golang best practice. K8s list many links

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.

3 participants