-
Notifications
You must be signed in to change notification settings - Fork 6
Add releasing note skills #1
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
+4,185
−1
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| name: vLLM Ascend Releasing Note Writer | ||
| description: You are a releasing note writer for vLLM Ascend project (vllm-project/vllm-ascend). You are responsible for writing release notes for vLLM Ascend. | ||
| --- | ||
|
|
||
| # vLLM Ascend Releasing Note Writer Skill | ||
|
|
||
| ## Overview | ||
| You should use the `ref-past-release-notes-highlight.md` as style and cateogry reference. Always read these first. | ||
|
|
||
| ## When to use this skill | ||
| When a new version of vLLM Ascend is released, you should use this skill to write the release notes. | ||
|
|
||
| ## How to use it | ||
| 0. all ouput files should be saved under `vllm-ascend-releasing-note/output/$version` folder | ||
|
|
||
| 1. Use the `fetch_commits-optimize.py` script to fetch the commits between the previous and current version. | ||
|
|
||
| ``` | ||
| uv run python fetch_commits-optimize.py --base-tag $LAST_TAG --head-tag $NEW_TAG --output 0-current-raw-commits.md | ||
| ``` | ||
| `0-current-raw-commits.md` is your raw data input. | ||
|
|
||
| 2. Use the `commit-analysis-draft.csv` tool to analyze the commits and put them into the correct section. | ||
| `1-commit-analysis-draft.csv` is your workspace for commit by commit analysis for which commit goes into which section, whether can be ignored, and why. You can create auxilariy files in `tmp` folder. | ||
| * You should check each commit. They are put into rows in the CSV file. | ||
| * The CSV should have headers `title`, `pr number`, `user facing impact/summary`, `catgory`, `decision`, `reason`. Please brainstorm other fields as you see fit. | ||
|
|
||
| 3. Draft the highlights note, and save it to `2-highlights-note-draft.md`. | ||
| 4. Edit the draft highlights note in `2-highlights-note-draft.md`, and save it to `3-highlights-note-edit.md`. You should double and triple check with the raw commits + analysis. You can leave any uncertainty and doubts in the file, and we will discuss them together. | ||
| 5. Use the format `This is the $NUMBER release candidate of $VERSION for vLLM Ascend. Please follow the [official doc](https://docs.vllm.ai/projects/ascend/en/latest) to get started.`. | ||
|
|
||
| ## Writing style | ||
| 1. To keep simple, you should only save one level of headings, starting with ###, which may include the following categories follow below order: | ||
| ### Highlights | ||
| ### Features | ||
| ### Hardware and Operator Support | ||
| ### Performance | ||
| ### Dependencies | ||
| ### Deprecation & Breaking Changes | ||
| ### Documentation | ||
| ### Others | ||
|
|
||
| 2. Additional Inclusion Criteria | ||
| * User experience improvements (CLI enhancements, better error messages, configuration flexibility) | ||
| * Core feature (PD Disaggregation, KVCaceh, Graph mode, CP/SP, quantization) | ||
| * Breaking changes and deprecations (always include with clear impact description) | ||
| * Significant infrastructure changes (elastic scaling, distributed serving, hardware support) | ||
| * Major dependency updates (CANN/torch_npu/triton-ascend/MoonCake/Ray/transformers versions, critical library updates) | ||
| * Binary/deployment improvements (size reductions, Docker enhancements) | ||
| * Default behavior changes (default models, configuration changes that affect all users) | ||
| * Hardware compatibility expansions (310P, A2, A3, A5 support) | ||
| In the end we don't want to miss any important changes. But also don't want to spam the notes with unnecessary details. | ||
|
|
||
| 3. Section Organization Guidelines | ||
| * **Model Support first**: Most immediately visible to users, should lead the highlights | ||
| * **Group by user impact**: Hardware/performance should focus on what users experience, not internal optimizations | ||
| * **Provide usage context**: Include relevant flags, configuration options, and practical usage information | ||
| * **Technical detail level**: Explain what features enable rather than just listing technical changes | ||
|
|
||
| 4. Writing Tips | ||
| * Look up the PR if you are not sure about the details. The PR number at the end (#12345) can be looked up via vllm-project/vllm#12345. To get the description, you just need to call https://api.github.com/repos/vllm-project/vllm/pulls/12345 and look at the body field. | ||
| * When writing the highlights, don't be too verbose. Focus exclusively on what users should know. |
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.
https://agentskills.io/specification#directory-structure
This check follows ^