-
Notifications
You must be signed in to change notification settings - Fork 29
add contributing.md #93
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: LiZhenCheng9527 <lizhencheng6@huawei.com>
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello @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 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. 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.
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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
|
||
| ## 🧭 Governance and Ownership | ||
|
|
||
| * Maintainers are listed in the top-level [`OWNERS`](./OWNERS) file and `OWNERS` files in subdirectories |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
|
||
| ## 🔐 Security Reporting | ||
|
|
||
| * For sensitive issues, email volcano-security@googlegroups.com instead of filing a public issue |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| * 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/` |
There was a problem hiding this comment.
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
Added CONTRIBUTING.md for agentCube.