Skip to content

Add feature branch policy #2432

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
merged 1 commit into from
Aug 21, 2025
Merged

Add feature branch policy #2432

merged 1 commit into from
Aug 21, 2025

Conversation

Yikun
Copy link
Collaborator

@Yikun Yikun commented Aug 19, 2025

What this PR does / why we need it?

This patch add the feature branch policy.

After this patch: maintainers are allowed to create a feature branch. Feature branches are used for collaboration and must include an RFC link, merge plan and mentor info.

Does this PR introduce any user-facing change?

No

How was this patch tested?

CI passed

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 introduces a feature branch policy and updates the documentation accordingly. The changes are a good step towards formalizing the development process. However, I've found a few inconsistencies and errors in the documentation that need to be addressed to ensure clarity and correctness. Specifically, the status of feature branches is inconsistent between files, information has been added to the wrong section in the Chinese README, and there's a grammatical error in the policy definition itself. Please see the detailed comments for suggestions.

@Yikun Yikun requested a review from jianzs August 19, 2025 03:29
@Yikun
Copy link
Collaborator Author

Yikun commented Aug 19, 2025

cc @wangxiyuan @ganyi1996ppo @jianzs @ApsarasX @MengqingCao @zzzzwwjj @jgong5

Considering that this is a content involving versioning policy, it is best to get reviews from most maintainers and active contributors. My main concern is maintenance cost and branches diverge too far, therefore, I added mentor and merge plan.

@@ -77,6 +77,7 @@ Below is maintained branches:
| v0.7.1-dev | Unmaintained | Only doc fixed is allowed |
| v0.7.3-dev | Maintained | CI commitment for vLLM 0.7.3 version, only bug fix is allowed and no new release tag any more. |
| v0.9.1-dev | Maintained | CI commitment for vLLM 0.9.1 version |
| rfc/feature-name | Maintained | [Feature branches](https://vllm-ascend.readthedocs.io/en/latest/community/versioning_policy.html#feature-branches) for collaboration |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this line should be added once a new branch is really comming?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is just an index, I think it will not be changed in future.

@ApsarasX
Copy link
Collaborator

Maybe we can refer to WebAssembly/proposals to tier our feature branches.

Copy link

👋 Hi! Thank you for contributing to the vLLM Ascend project. The following points will speed up your PR merge:‌‌

  • A PR should do only one thing, smaller PRs enable faster reviews.
  • Every PR should include unit tests and end-to-end tests ‌to ensure it works and is not broken by other future PRs.
  • Write the commit message by fulfilling the PR description to help reviewer and future developers understand.

If CI fails, you can run linting and testing checks locally according Contributing and Testing.

Copy link
Collaborator

@MengqingCao MengqingCao left a comment

Choose a reason for hiding this comment

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

lgtm

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 19, 2025
@Yikun
Copy link
Collaborator Author

Yikun commented Aug 19, 2025

Maybe we can refer to WebAssembly/proposals to tier our feature branches.

Thanks for info, this PR is only for feature branch, but not for proposal workflow. But I think your link about proposals is also very useful to help us manage proprosals.

@wangxiyuan
Copy link
Collaborator

please fix the lint error, then let's merge this

Signed-off-by: Yikun Jiang <yikunkero@gmail.com>
@Yikun
Copy link
Collaborator Author

Yikun commented Aug 21, 2025

Thanks all @ganyi1996ppo @MengqingCao @ApsarasX Let's first merge this to see feature branch works as our expected! If it's unexpected, please feel free to tell me, we can revert this policy.

@Yikun Yikun merged commit 67a222c into vllm-project:main Aug 21, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants