-
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
Merged
+115
−190
Merged
Update docs #13391
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
666bc31
update code
sglang-bot a86d588
update docs
sglang-bot 4a4f2c5
improve docs
sglang-bot d737e85
Fix docs
sglang-bot 513278c
Fix
sglang-bot 0eeca11
update
sglang-bot 0bf5c66
Fix
sglang-bot fa6ab4a
Fix
sglang-bot 6859afc
Fix
merrymercy 23cabac
Fix
sglang-bot 4c0db15
simplify labelre.yml
sglang-bot e04bd1c
Fix lint
sglang-bot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # SGLang Code Maintenance Model | ||
| This documentation describes the code maintenance model for the SGLang project. | ||
| Since SGLang is a large project involving multiple organizations and hardware platforms, we designed this model with the following goals: | ||
| - Ensure a responsive and smooth review process. | ||
| - Allow fast iteration, so maintainers can sometimes bypass flaky CI tests for important PRs. | ||
|
|
||
| ## Role Descriptions | ||
| There are four important roles in this maintenance model. Some are custom roles, while the others are roles predefined by GitHub. | ||
|
|
||
| - *Area Maintainer*: The person who drives the PR merge process. They have strong area expertise and hold a high code quality bar. | ||
| - Permission: Merge PRs. Bypass branch protection rules if needed. | ||
| - Responsibility: Shepherd the merge of PRs assigned to your area. Revert or hotfix any issues related to your merge (especially if you bypass). | ||
| - *Codeowner*: The person who protects critical code. Without bypass, each PR needs at least one Codeowner approval for each modified file. Please note that this role is not an honor but a great responsibility because PRs cannot be merged without your approval (except when bypassed by an Area Maintainer). | ||
| - Permission: Approve PRs, allowing them to be merged without bypass. | ||
| - Responsibility: Review PRs in a timely manner. | ||
| - *Write*: The person with write permission to the sglang repo. | ||
| - Permission: Merge PRs if they have passed required tests and been approved by Codeowners. This role cannot bypass branch protection rules. | ||
| - Responsibility: Review and merge PRs in a timely manner. | ||
| - *CI Maintainer*: The person who manages CI runners for specific hardware platforms. | ||
| - Permission: Add CI runners. | ||
| - Responsibility: Keep the CI runners up and running. | ||
|
|
||
| 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 @-mention 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. | ||
| - 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. | ||
|
|
||
| ## The List of Area Maintainers and Reviewers | ||
| TODO | ||
|
|
||
| ## The List of CI Maintainers | ||
| TODO |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| Popular Model Usage (DeepSeeek, GPT-OSS, Llama, Qwen, and more) | ||
| =============================================================== | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| deepseek_v3.md | ||
| deepseek_v32.md | ||
| gpt_oss.md | ||
| llama4.md | ||
| qwen3.md | ||
| qwen3_vl.md |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.