Reference governance files in the community repository #125
Conversation
Replace the inline maintainers list with a reference to the centralized community maintainers file to ensure the list stays up to date and consistent across projects. Signed-off-by: Peng Tao <[email protected]>
Remove the detailed governance document and replace it with a pointer to the project's centralized community governance file. This simplifies maintenance by consolidating governance information in a single location. Signed-off-by: Peng Tao <[email protected]>
Remove the detailed contributing instructions and replace the file content with a reference link to the centralized community contributors' guide for consistency and easier maintenance. Signed-off-by: Peng Tao <[email protected]>
Summary of ChangesHello @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! This pull request streamlines the project's documentation by consolidating its governance, contribution, and maintainer information into a central community repository. Instead of maintaining separate copies within this project, all relevant files now point to 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request aims to centralize governance documents by linking to a common community repository, which is a great initiative for consistency. However, my review has identified a couple of potential issues where repository-specific information (like contribution setup and meeting schedules) is being removed. This could make it harder for contributors to find this information. I've left specific comments on the affected files with suggestions on how to address this. I also noted a minor inconsistency in the wording of the new files.
| ``` | ||
|
|
||
| We appreciate your contributions and look forward to working with you! | ||
| Please refer to the project's [community contributors' guide](https://github.com/modelpack/community/blob/main/CONTRIBUTING.md) for guidelines on how to contribute to the project. |
There was a problem hiding this comment.
This change removes repository-specific contribution guidelines, such as environment setup (Go installation, golangci-lint) and local CI validation steps. While centralizing documentation is a good goal, losing this specific information could make it harder for new contributors to get started on this repository. Please consider whether this information is present in the new community contributors' guide, or if it should be preserved here alongside the link to the general guide. For example, you could have a section for repository-specific setup instructions.
| ## Modifying this Charter | ||
|
|
||
| Changes to this Governance and its supporting documents may be approved by a 2/3 vote of the Maintainers. | ||
| Please refer to the project's [community governance file](https://github.com/modelpack/community/blob/main/GOVERNANCE.md) for details on the governance structure and decision-making processes. |
There was a problem hiding this comment.
The previous GOVERNANCE.md contained specific information about "ModelSpec Public Office Hours", including the schedule and meeting link. If these meetings are specific to the model-spec project, this information might be lost by pointing to a generic community governance file. Please ensure that project-specific governance details like meeting schedules are still easily accessible to the community, perhaps by keeping them in this file or moving them to another appropriate location like the README.md.
| - sabre1041 | ||
| - tarilabs | ||
| - wy65701436 | ||
| Please refer to [the project's community maintainers file](https://github.com/modelpack/community/blob/main/MAINTAINERS.md) for the list of maintainers and their roles. |
There was a problem hiding this comment.
For consistency with the other updated documentation files (CONTRIBUTING.md and GOVERNANCE.md), consider moving "the project's" outside of the markdown link text.
| Please refer to [the project's community maintainers file](https://github.com/modelpack/community/blob/main/MAINTAINERS.md) for the list of maintainers and their roles. | |
| Please refer to the project's [community maintainers file](https://github.com/modelpack/community/blob/main/MAINTAINERS.md) for the list of maintainers and their roles. |
3 participants
So that we have a single source of truth for project governance rules.