Skip to content

[Doc] Improve a few text in README.md#457

Merged
YuhanLiu11 merged 2 commits into
vllm-project:mainfrom
windsonsea:vllre
Jun 2, 2025
Merged

[Doc] Improve a few text in README.md#457
YuhanLiu11 merged 2 commits into
vllm-project:mainfrom
windsonsea:vllre

Conversation

@windsonsea

Copy link
Copy Markdown
Contributor

Only update a few text for readability.


  • Make sure the code changes pass the pre-commit checks.
  • Sign-off your commit by using -s when doing git commit
  • Try to classify PRs for easy understanding of the type of changes, such as [Bugfix], [Feat], and [CI].
Detailed Checklist (Click to Expand)

Thank you for your contribution to production-stack! Before submitting the pull request, please ensure the PR meets the following criteria. This helps us maintain the code quality and improve the efficiency of the review process.

PR Title and Classification

Please try to classify PRs for easy understanding of the type of changes. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:

  • [Bugfix] for bug fixes.
  • [CI/Build] for build or continuous integration improvements.
  • [Doc] for documentation fixes and improvements.
  • [Feat] for new features in the cluster (e.g., autoscaling, disaggregated prefill, etc.).
  • [Router] for changes to the vllm_router (e.g., routing algorithm, router observability, etc.).
  • [Misc] for PRs that do not fit the above categories. Please use this sparingly.

Note: If the PR spans more than one category, please include all relevant prefixes.

Code Quality

The PR need to meet the following code quality standards:

  • Pass all linter checks. Please use pre-commit to format your code. See README.md for installation.
  • The code need to be well-documented to ensure future contributors can easily understand the code.
  • Please include sufficient tests to ensure the change is stay correct and robust. This includes both unit tests and integration tests.

DCO and Signed-off-by

When contributing changes to this project, you must agree to the DCO. Commits must include a Signed-off-by: header which certifies agreement with the terms of the DCO.

Using -s with git commit will automatically add this header.

What to Expect for the Reviews

We aim to address all PRs in a timely manner. If no one reviews your PR within 5 days, please @-mention one of YuhanLiu11
, Shaoting-Feng or ApostaC.

Signed-off-by: windsonsea <haifeng.yao@daocloud.io>

@YuhanLiu11 YuhanLiu11 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix!

@YuhanLiu11 YuhanLiu11 enabled auto-merge (squash) June 2, 2025 22:27
@YuhanLiu11 YuhanLiu11 merged commit aee842c into vllm-project:main Jun 2, 2025
5 of 6 checks passed
JustinDuy pushed a commit to JustinDuy/production-stack-1 that referenced this pull request Jun 13, 2025
Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
davidgao7 pushed a commit to davidgao7/production-stack that referenced this pull request Jun 26, 2025
Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
Signed-off-by: David Gao <davidgao313@outlook.com>
Senne-Mennes pushed a commit to Senne-Mennes/production-stack that referenced this pull request Oct 22, 2025
Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
Signed-off-by: senne.mennes@capgemini.com <senne.mennes@capgemini.com>
emanuelecassese pushed a commit to emanuelecassese/production-stack that referenced this pull request Jan 30, 2026
Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
BadLord1st pushed a commit to BadLord1st/vllm-production-stack that referenced this pull request Feb 1, 2026
Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants