-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Update docs #13391
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
Update docs #13391
Conversation
merrymercy
commented
Nov 17, 2025
- Introduce SGLang Code Maintenance Model
- Fix other minor details
Summary of ChangesHello @merrymercy, 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 primarily focuses on updating and improving the project's documentation and internal governance. It introduces a new, more structured code maintenance model to clarify roles and responsibilities, aiming for a more efficient development workflow. Additionally, it refines user-facing documentation, updating information on supported models, community growth, installation procedures, and troubleshooting, while also enhancing issue submission templates for better user experience. 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
|
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 primarily focuses on updating and reorganizing documentation. It introduces a new MAINTAINER.md file that defines the code maintenance model, removes the old REVIEWERS.md, and refactors the documentation structure for popular models. Additionally, issue templates have been streamlined for better usability, and various other documents have been updated to reflect the latest project status. My review includes a suggestion regarding a change in the CODEOWNERS file to ensure new code is always reviewed, and some minor wording improvements for the new maintenance documentation.
| /docker @Fridge003 @ispobock @HaiShaw @ishandhanani | ||
| /docker/npu.Dockerfile @ping1jing2 @iforgetmyname | ||
| /python/pyproject.toml @merrymercy @Fridge003 @ispobock | ||
| /python/sglang/* @merrymercy @Ying1123 @Fridge003 @ispobock @hnyls2002 |
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.
Removing the wildcard rule /python/sglang/* could be risky. While there are many specific rules for subdirectories, any new file or directory created directly under /python/sglang/ that doesn't match an existing pattern will now have no code owner. This could lead to unreviewed changes slipping through. Consider re-adding a general rule for /python/sglang/* with a default set of owners to act as a fallback.
.github/MAINTAINER.md
Outdated
| Note: Difference between Area Maintainer and Codeowner | ||
| - Area Maintainer is an active role who actively try to help merge PRs and can bypass CI if urgent. | ||
| - Codeowner is a passive protection rule provided by GitHub; it prevents accidental changes to critical code. | ||
| - The list of Area Maintainer is attached below. The list of Codeowner is in [CODEOWNERS](./CODEOWNERS) file. | ||
|
|
||
| ## Pull Request Merge Process | ||
| 1. Author submits a pull request (PR) and fills out the PR checklist. | ||
| 2. A bot assigns this PR to an Area Maintainer and @ them. At the same time, GitHub will auto-request reviews from Codeowners. | ||
| 3. The Area Maintainer coordinates the review (asking people to review) and approves the PR; the Codeowner approves the PR. | ||
| 4. We can now merge the code: | ||
| - Ideal case: For each modified file, one Codeowner approves the PR. It also passes the required CI. Then anyone with write permission can merge the code. | ||
| - It is often very hard to meet all requirements due to flaky CI and slow responses. Area Maintainer can bypass the branch protection and merge the PR. |
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.
This is a great document explaining the maintenance model! I have a few minor suggestions to improve clarity and grammar:
- Line 24: "...who actively try to help..." could be rephrased to "...who is responsible for helping..." for better clarity on the role's duty.
- Line 26: "Area Maintainer" and "Codeowner" should be pluralized to "Area Maintainers" and "Codeowners" for grammatical correctness.
- Line 30: "@ them" is a bit informal. Consider using "@-mentions them". Also, "auto-request" could be "automatically requests".
- Line 34: The sentence could be rephrased for better flow, for example: "In cases where it is difficult to meet all requirements due to flaky CI or slow responses, an Area Maintainer can bypass branch protection to merge the PR."