Initial setup #1
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @bergwolf, 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!
I've initiated the foundational setup for community documentation by adding key files that will guide contributions, define project governance, and establish a code of conduct. This effort aims to create a clear and structured environment for the ModelPack/ModelSpec project, ensuring transparency and fostering a healthy community from the outset.
Highlights
- Contribution Guidelines: I've added CONTRIBUTING.md to provide comprehensive guidelines for external contributions, covering successful change processes, commit message standards, license header requirements, and the Developer Certificate of Origin (DCO).
- Project Governance: I've introduced GOVERNANCE.md to define the project's operational structure, including core values, maintainer responsibilities, the process for becoming or removing a maintainer, and details on project meetings.
- Code of Conduct: I've included code-of-conduct.md to formally adopt the CNCF Code of Conduct, ensuring a respectful and inclusive environment for all participants.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request sets up the initial community documentation, including contributing guidelines, project governance, and a code of conduct. The documents are comprehensive and provide a good foundation for the project. My review includes several suggestions to improve clarity and consistency, particularly regarding the project's name, meeting schedules, and general wording in the markdown files. Addressing these points will help ensure the documentation is clear and professional for new contributors.
bergwolf
force-pushed
the
initial-setup
branch
from
0de17f5 to
d902159
Compare
GOVERNANCE.md
Outdated
|
|
||
| ## Code of Conduct | ||
|
|
||
| Everything we do in the ModelPack community is governed by our [Code of Conduct](./code-of-conduct.md). Violations by community members will be discussed and resolved by the Maintainers in their private Discord channel. If a Maintainer is directly involved in the report, the Maintainers will instead designate two Maintainers to resolve the issue. |
There was a problem hiding this comment.
| Everything we do in the ModelPack community is governed by our [Code of Conduct](./code-of-conduct.md). Violations by community members will be discussed and resolved by the Maintainers in their private Discord channel. If a Maintainer is directly involved in the report, the Maintainers will instead designate two Maintainers to resolve the issue. | |
| Everything we do in the ModelPack community is governed by our [Code of Conduct](./code-of-conduct.md). Violations by community members will be discussed and resolved by the Maintainers in a private forum. If a Maintainer is directly involved in the report, the Maintainers will instead designate two Maintainers to resolve the issue. |
There was a problem hiding this comment.
There is no private maintainers Slack channel. Should a maintainers channel be established?
Add a CONTRIBUTING.md file outlining the process for submitting pull requests, coordination with maintainers, and expectations for contributions. Include guidance on writing effective commit messages, applying license headers, and signing off contributions to ensure clarity and compliance in the project's collaboration workflow. Signed-off-by: Peng Tao <[email protected]>
bergwolf
force-pushed
the
initial-setup
branch
from
d902159 to
8e0d0c0
Compare
Add a GOVERNANCE.md outlining the ModelSpec project's governance structure, values, maintainer roles and responsibilities, meeting schedules, and code of conduct enforcement. The zoom meeting info is also updated to use the LFX one. Signed-off-by: Peng Tao <[email protected]>
Introduce a new code-of-conduct.md file outlining the CNCF ModelPack project's adherence to the CNCF Code of Conduct. This establishes community guidelines and expected behavior. Signed-off-by: Peng Tao <[email protected]>
bergwolf
force-pushed
the
initial-setup
branch
from
8e0d0c0 to
50f43b2
Compare
|
@sabre1041 updated. Please take another look, thanks! |
Let's move the community docs to a dedicated repository.