From 5aeb04cc55ba022af1f38d0f563651e81d179ff6 Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 14 Mar 2024 14:42:14 -0700 Subject: [PATCH 01/15] add pr templates --- .github/PULL_REQUEST_TEMPLATE/1.md | 1 + .github/PULL_REQUEST_TEMPLATE/2.md | 1 + 2 files changed, 2 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/1.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/2.md diff --git a/.github/PULL_REQUEST_TEMPLATE/1.md b/.github/PULL_REQUEST_TEMPLATE/1.md new file mode 100644 index 0000000000000..d654202c6425c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/1.md @@ -0,0 +1 @@ +# 1 diff --git a/.github/PULL_REQUEST_TEMPLATE/2.md b/.github/PULL_REQUEST_TEMPLATE/2.md new file mode 100644 index 0000000000000..b1eab243c801f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/2.md @@ -0,0 +1 @@ +# 2 From 207473180b4d16f4fd5d970207fd7c74dba6edcc Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 14 Mar 2024 14:45:47 -0700 Subject: [PATCH 02/15] add pr templates --- .github/PULL_REQUEST_TEMPLATE/2.md | 1 - .github/PULL_REQUEST_TEMPLATE/{1.md => pull_request_template.md} | 0 2 files changed, 1 deletion(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE/2.md rename .github/PULL_REQUEST_TEMPLATE/{1.md => pull_request_template.md} (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE/2.md b/.github/PULL_REQUEST_TEMPLATE/2.md deleted file mode 100644 index b1eab243c801f..0000000000000 --- a/.github/PULL_REQUEST_TEMPLATE/2.md +++ /dev/null @@ -1 +0,0 @@ -# 2 diff --git a/.github/PULL_REQUEST_TEMPLATE/1.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE/1.md rename to .github/PULL_REQUEST_TEMPLATE/pull_request_template.md From 4c9c93627f3ab23c1712437550fb63312d99f2b7 Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 14 Mar 2024 14:48:19 -0700 Subject: [PATCH 03/15] add pr templates --- .../pull_request_template.md => PULL_REQUEST_TEMPLATE.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/{PULL_REQUEST_TEMPLATE/pull_request_template.md => PULL_REQUEST_TEMPLATE.md} (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE/pull_request_template.md rename to .github/PULL_REQUEST_TEMPLATE.md From 5527fa0891824ff721ddc594cac7139494af84a6 Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 14 Mar 2024 15:26:05 -0700 Subject: [PATCH 04/15] add pr templates --- .github/PULL_REQUEST_TEMPLATE.md | 36 +++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d654202c6425c..e4995cf6fa6a5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1 +1,35 @@ -# 1 +## PR Checklist + +Before submitting your pull request, please ensure you have met the following criteria. This helps us maintain quality and efficiency in our review process. Check each box to indicate your understanding and compliance: + +### PR Title And Classification + +- [ ] **I understand that** only specific types of PRs will be reviewed. My PR title is prefixed appropriately to indicate the type of change, using one of the following: + + - [ ] `[Doc]` for documentation fixes. + - [ ] `[Bugfix]` for bug fixes. + - [ ] `[CI/Build]` for build or continuous integration improvements. + - [ ] `[Model]` for adding a new model or improving an existing model. Model name should appear in the title. + - [ ] `[Kernel]` for changes affecting computation kernels. + - [ ] `[Hardware][Vendor]` for hardware-specific changes. Vendor name should appear in the prefix, e.g., `[Hardware][AMD]`. + - [ ] `[Misc]` for PRs that do not fit the above categories. Please use this sparingly. + + - **Note:** If my PR spans more than one category, I will include all relevant prefixes. + +### Coding Standards + +- [ ] **I understand that** I must run `./format.sh` **before submitting the PR and after any new commits** to ensure compliance with linter checks. PRs failing to meet linter standards will not be reviewed or merged. + +### Code Quality + +- [ ] **I understand that** my code must be well-commented and include sufficient tests, ensuring future contributors can easily understand and modify the codebase. + +### Documentation for User-Facing Changes + +- [ ] **I understand that** if my PR introduces user-facing changes, it must be accompanied by relevant documentation to help users understand and utilize the new features or changes. + +Thank you for your contribution! + +## PR Justification + +Please provide a brief explanation of the motivation behind the PR and the changes it introduces. This helps reviewers understand the context and rationale for the contribution. From 97ba6659423cb3612c1e09300ce65eec86d5eba7 Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 14 Mar 2024 19:35:06 -0700 Subject: [PATCH 05/15] add pr templates --- .github/PULL_REQUEST_TEMPLATE.md | 37 ++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e4995cf6fa6a5..2b3eae1276768 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,40 @@ +
+

PR Checklist

+

Before submitting your pull request, please ensure you have met the following criteria. This helps us maintain quality and efficiency in our review process.

+ +

PR Title And Classification

+

I understand that only specific types of PRs will be reviewed. My PR title is prefixed appropriately to indicate the type of change, using one of the following:

+
    +
  • [Doc] for documentation fixes.
    • +
  • [Bugfix] for bug fixes.
    • +
  • [CI/Build] for build or continuous integration improvements.
    • +
  • [Model] for adding a new model or improving an existing model. Model name should appear in the title.
    • +
  • [Kernel] for changes affecting computation kernels.
    • +
  • [Hardware][Vendor] for hardware-specific changes. Vendor name should appear in the prefix, e.g., [Hardware][AMD].
    • +
  • [Misc] for PRs that do not fit the above categories. Please use this sparingly.
    • +
+

Note: If my PR spans more than one category, I will include all relevant prefixes.

+ +

Coding Standards

+

I understand that I must run ./format.sh before submitting the PR and after any new commits to ensure compliance with linter checks. PRs failing to meet linter standards will not be reviewed or merged.

+ +

Code Quality

+

I understand that my code must be well-commented and include sufficient tests, ensuring future contributors can easily understand and modify the codebase.

+ +

Documentation for User-Facing Changes

+

I understand that if my PR introduces user-facing changes, it must be accompanied by relevant documentation to help users understand and utilize the new features or changes.

+ +

Thank you for your contribution!

+ +

PR Justification

+

Please provide a brief explanation of the motivation behind the PR and the changes it introduces. This helps reviewers understand the context and rationale for the contribution.

+
+ + +## PR Justification + +Please provide a brief explanation of the motivation behind the PR and the changes it introduces. This helps reviewers understand the context and rationale for the contribution. + ## PR Checklist Before submitting your pull request, please ensure you have met the following criteria. This helps us maintain quality and efficiency in our review process. Check each box to indicate your understanding and compliance: From 65ad070236101dc76531fd6e28f23e011b1e331e Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 14 Mar 2024 21:35:53 -0700 Subject: [PATCH 06/15] mix html and markdown for pr template --- .github/PULL_REQUEST_TEMPLATE.md | 43 -------------------------------- 1 file changed, 43 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2b3eae1276768..084b9a9e5e8ca 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -26,47 +26,4 @@

Thank you for your contribution!

-

PR Justification

-

Please provide a brief explanation of the motivation behind the PR and the changes it introduces. This helps reviewers understand the context and rationale for the contribution.

- - -## PR Justification - -Please provide a brief explanation of the motivation behind the PR and the changes it introduces. This helps reviewers understand the context and rationale for the contribution. - -## PR Checklist - -Before submitting your pull request, please ensure you have met the following criteria. This helps us maintain quality and efficiency in our review process. Check each box to indicate your understanding and compliance: - -### PR Title And Classification - -- [ ] **I understand that** only specific types of PRs will be reviewed. My PR title is prefixed appropriately to indicate the type of change, using one of the following: - - - [ ] `[Doc]` for documentation fixes. - - [ ] `[Bugfix]` for bug fixes. - - [ ] `[CI/Build]` for build or continuous integration improvements. - - [ ] `[Model]` for adding a new model or improving an existing model. Model name should appear in the title. - - [ ] `[Kernel]` for changes affecting computation kernels. - - [ ] `[Hardware][Vendor]` for hardware-specific changes. Vendor name should appear in the prefix, e.g., `[Hardware][AMD]`. - - [ ] `[Misc]` for PRs that do not fit the above categories. Please use this sparingly. - - - **Note:** If my PR spans more than one category, I will include all relevant prefixes. - -### Coding Standards - -- [ ] **I understand that** I must run `./format.sh` **before submitting the PR and after any new commits** to ensure compliance with linter checks. PRs failing to meet linter standards will not be reviewed or merged. - -### Code Quality - -- [ ] **I understand that** my code must be well-commented and include sufficient tests, ensuring future contributors can easily understand and modify the codebase. - -### Documentation for User-Facing Changes - -- [ ] **I understand that** if my PR introduces user-facing changes, it must be accompanied by relevant documentation to help users understand and utilize the new features or changes. - -Thank you for your contribution! - -## PR Justification - -Please provide a brief explanation of the motivation behind the PR and the changes it introduces. This helps reviewers understand the context and rationale for the contribution. From 5b662bee55c49dd118ab940759fe2510b8e00fb4 Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 14 Mar 2024 21:39:01 -0700 Subject: [PATCH 07/15] add justification and rfc requirement --- .github/PULL_REQUEST_TEMPLATE.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 084b9a9e5e8ca..7f42a85c31c84 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -27,3 +27,13 @@

Thank you for your contribution!

+ +## PR Justification + +Please provide a brief explanation of the motivation behind the PR and the changes it introduces. This helps reviewers understand the context and rationale for the contribution. + +If possible, please link existing issues this PR will resolve. + +## Note for large changes + +For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue discussing the technical design and justification. Otherwise, we will tag it with `rfc-required` and might not take a look at the PR. From f5ff64fa3c161f6708fac83ef11dd154e680ef05 Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 14 Mar 2024 21:41:13 -0700 Subject: [PATCH 08/15] add rationale for html --- .github/PULL_REQUEST_TEMPLATE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7f42a85c31c84..f318b70afadf3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,6 @@
-

PR Checklist

+ +

PR Checklist (Please do have a look before submitting a PR!)

Before submitting your pull request, please ensure you have met the following criteria. This helps us maintain quality and efficiency in our review process.

PR Title And Classification

From 289fa6057896be9d868ddb71082c08f056af2e29 Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 14 Mar 2024 21:42:32 -0700 Subject: [PATCH 09/15] fix simon suggestion --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f318b70afadf3..48fea37229944 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -17,7 +17,7 @@

Note: If my PR spans more than one category, I will include all relevant prefixes.

Coding Standards

-

I understand that I must run ./format.sh before submitting the PR and after any new commits to ensure compliance with linter checks. PRs failing to meet linter standards will not be reviewed or merged.

+

I understand that I must run ./format.sh before submitting the PR and after any new commits to ensure compliance with linter checks. PRs failing to meet linter standards will not be merged.

Code Quality

I understand that my code must be well-commented and include sufficient tests, ensuring future contributors can easily understand and modify the codebase.

From a62f362fbd6c5a920414002af1ed3099941026fb Mon Sep 17 00:00:00 2001 From: youkaichao Date: Thu, 14 Mar 2024 21:44:15 -0700 Subject: [PATCH 10/15] add click instruction --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 48fea37229944..2d3e371ff83bd 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@
-

PR Checklist (Please do have a look before submitting a PR!)

+

PR Checklist (Click to expand. Please do have a look before submitting a PR!)

Before submitting your pull request, please ensure you have met the following criteria. This helps us maintain quality and efficiency in our review process.

PR Title And Classification

From 3959d06d7a875ea017e133c3b97f0f1fb0948a34 Mon Sep 17 00:00:00 2001 From: youkaichao Date: Fri, 15 Mar 2024 00:44:39 -0700 Subject: [PATCH 11/15] Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Zhuohan Li --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2d3e371ff83bd..92931e338d7bb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -37,4 +37,4 @@ If possible, please link existing issues this PR will resolve. ## Note for large changes -For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue discussing the technical design and justification. Otherwise, we will tag it with `rfc-required` and might not take a look at the PR. +For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue discussing the technical design and justification. Otherwise, we will tag it with `rfc-required` and might not go through the PR. From da64bddfa9f3fc37d1e1092d430461fe6849be3b Mon Sep 17 00:00:00 2001 From: youkaichao Date: Fri, 15 Mar 2024 00:44:56 -0700 Subject: [PATCH 12/15] Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Zhuohan Li --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 92931e338d7bb..2619a311ea626 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -17,7 +17,7 @@

Note: If my PR spans more than one category, I will include all relevant prefixes.

Coding Standards

-

I understand that I must run ./format.sh before submitting the PR and after any new commits to ensure compliance with linter checks. PRs failing to meet linter standards will not be merged.

+

I understand that I should run format.sh before submitting the PR and after any new commits to ensure compliance with linter checks. PRs failing to meet linter standards will not be merged.

Code Quality

I understand that my code must be well-commented and include sufficient tests, ensuring future contributors can easily understand and modify the codebase.

From b6ed19b42a60d113f2b76d31ef4c9b0247e131e0 Mon Sep 17 00:00:00 2001 From: youkaichao Date: Fri, 15 Mar 2024 00:45:09 -0700 Subject: [PATCH 13/15] Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Zhuohan Li --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2619a311ea626..300c0733f22b5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@
-

PR Checklist (Click to expand. Please do have a look before submitting a PR!)

+

PR Checklist (Click to expand. Please take a look before submitting a PR!)

Before submitting your pull request, please ensure you have met the following criteria. This helps us maintain quality and efficiency in our review process.

PR Title And Classification

From 5c9dddb889dad7105a7173465f5afbba539240d3 Mon Sep 17 00:00:00 2001 From: youkaichao Date: Fri, 15 Mar 2024 00:45:49 -0700 Subject: [PATCH 14/15] Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Zhuohan Li --- .github/PULL_REQUEST_TEMPLATE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 300c0733f22b5..f3cd3b68e3da3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -10,6 +10,7 @@
  • [Bugfix] for bug fixes.
  • [CI/Build] for build or continuous integration improvements.
  • [Model] for adding a new model or improving an existing model. Model name should appear in the title.
    • +
  • [Core] for changes in the core vLLM (e.g., LLMEngine, Scheduler, etc.)
  • [Kernel] for changes affecting computation kernels.
  • [Hardware][Vendor] for hardware-specific changes. Vendor name should appear in the prefix, e.g., [Hardware][AMD].
  • [Misc] for PRs that do not fit the above categories. Please use this sparingly.
    • From 64ea5559e7d991637207139d7cba49120df0ac4e Mon Sep 17 00:00:00 2001 From: Zhuohan Li Date: Fri, 15 Mar 2024 23:04:59 +0000 Subject: [PATCH 15/15] Update PR template --- .github/PULL_REQUEST_TEMPLATE.md | 65 +++++++++++++++++++++----------- CONTRIBUTING.md | 26 +------------ 2 files changed, 44 insertions(+), 47 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f3cd3b68e3da3..46fda7eeef55e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,41 +1,60 @@
    - -

    PR Checklist (Click to expand. Please take a look before submitting a PR!)

    -

    Before submitting your pull request, please ensure you have met the following criteria. This helps us maintain quality and efficiency in our review process.

    + + PR Checklist (Click to expand. Please read before submitting.) -

    PR Title And Classification

    -

    I understand that only specific types of PRs will be reviewed. My PR title is prefixed appropriately to indicate the type of change, using one of the following:

    +

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

    + +

    PR Title and Classification

    +

    Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:

      -
    • [Doc] for documentation fixes.
    • [Bugfix] for bug fixes.
    • [CI/Build] for build or continuous integration improvements.
      • +
    • [Doc] for documentation fixes and improvements.
    • [Model] for adding a new model or improving an existing model. Model name should appear in the title.
      • -
    • [Core] for changes in the core vLLM (e.g., LLMEngine, Scheduler, etc.)
      • -
    • [Kernel] for changes affecting computation kernels.
      • -
    • [Hardware][Vendor] for hardware-specific changes. Vendor name should appear in the prefix, e.g., [Hardware][AMD].
      • +
    • [Frontend] For changes on the vLLM frontend (e.g., OpenAI API server, LLM class, etc.)
      • +
    • [Kernel] for changes affecting CUDA kernels or other compute kernels.
      • +
    • [Core] for changes in the core vLLM logic (e.g., LLMEngine, AsyncLLMEngine, Scheduler, etc.)
      • +
    • [Hardware][Vendor] for hardware-specific changes. Vendor name should appear in the prefix (e.g., [Hardware][AMD]).
    • [Misc] for PRs that do not fit the above categories. Please use this sparingly.
    -

    Note: If my PR spans more than one category, I will include all relevant prefixes.

    - -

    Coding Standards

    -

    I understand that I should run format.sh before submitting the PR and after any new commits to ensure compliance with linter checks. PRs failing to meet linter standards will not be merged.

    +

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

    Code Quality

    -

    I understand that my code must be well-commented and include sufficient tests, ensuring future contributors can easily understand and modify the codebase.

    -

    Documentation for User-Facing Changes

    -

    I understand that if my PR introduces user-facing changes, it must be accompanied by relevant documentation to help users understand and utilize the new features or changes.

    +

    The PR need to meet the following code quality standards:

    -

    Thank you for your contribution!

    +
      +
    • We adhere to Google Python style guide and Google C++ style guide.
      • +
    • Pass all linter checks. Please use format.sh to format your code.
      • +
    • The code need to be well-documented to ensure future contributors can easily understand the code.
      • +
    • Include sufficient tests to ensure the project to stay correct and robust. This includes both unit tests and integration tests.
      • +
    • Please add documentation to docs/source/ if the PR modifies the user-facing behaviors of vLLM. It helps vLLM user understand and utilize the new features or changes.
      • +
    -
    +

    Notes for Large Changes

    +

    Please keep the changes as concise as possible. For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue (RFC) discussing the technical design and justification. Otherwise, we will tag it with rfc-required and might not go through the PR.

    + +

    What to Expect for the Reviews

    + +

    The goal of the vLLM team is to be a transparent reviewing machine. We would like to make the review process transparent and efficient and make sure no contributor feel confused or frustrated. However, the vLLM team is small, so we need to prioritize some PRs over others. Here is what you can expect from the review process:

    -## PR Justification +
      +
    • After the PR is submitted, the PR will be assigned to a reviewer. Every reviewer will pick up the PRs based on their expertise and availability.
      • +
    • After the PR is assigned, the reviewer will provide status update every 2-3 days. If the PR is not reviewed within 7 days, please feel free to ping the reviewer or the vLLM team.
      • +
    • After the review, the reviewer will put an action-required label on the PR if there are changes required. The contributor should address the comments and ping the reviewer to re-review the PR.
      • +
    • Please respond to all comments within a reasonable time frame. If a comment isn't clear or you disagree with a suggestion, feel free to ask for clarification or discuss the suggestion. +
      • +
    + +

    Thank You

    + +

    Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM. Your contributions make vLLM a great tool for everyone!

    + + +
    -Please provide a brief explanation of the motivation behind the PR and the changes it introduces. This helps reviewers understand the context and rationale for the contribution. +--- -If possible, please link existing issues this PR will resolve. +Please provide a brief explanation of the motivation behind the PR and the changes it introduces. This helps reviewers understand the context and rationale for the contribution. If possible, please link existing issues this PR will resolve. -## Note for large changes -For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue discussing the technical design and justification. Otherwise, we will tag it with `rfc-required` and might not go through the PR. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 93a4de73faa89..8db5e569b6aec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,31 +45,9 @@ pytest tests/ If you encounter a bug or have a feature request, please check our issues page first to see if someone else has already reported it. If not, please file a new issue, providing as much relevant information as possible. -### Coding Style Guide +### Pull Requests & Code Reviews -In general, we adhere to [Google Python style guide](https://google.github.io/styleguide/pyguide.html) and [Google C++ style guide](https://google.github.io/styleguide/cppguide.html). - -We include a formatting script [`format.sh`](./format.sh) to format the code. - -### Pull Requests - -When submitting a pull request: - -1. Make sure your code has been rebased on top of the latest commit on the main branch. -2. Ensure code is properly formatted by running [`format.sh`](./format.sh). -3. Include a detailed description of the changes in the pull request. -Explain why you made the changes you did. -If your pull request fixes an open issue, please include a reference to it in the description. - -### Code Reviews - -All submissions, including submissions by project members, require a code review. -To make the review process as smooth as possible, please: - -1. Keep your changes as concise as possible. -If your pull request involves multiple unrelated changes, consider splitting it into separate pull requests. -2. Respond to all comments within a reasonable time frame. -If a comment isn't clear or you disagree with a suggestion, feel free to ask for clarification or discuss the suggestion. +Please check the PR checklist in the [PR template](.github/PULL_REQUEST_TEMPLATE.md) for detailed guide for contribution. ### Thank You