EngineX/xc-llm-ascend
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[Doc][Misc] Update AGENTS.md with sign-off and PR template requirements (#6892)

Browse Source 
### What this PR does / why we need it?

This PR enhances the `AGENTS.md` contribution guidelines with the
following improvements:

1. **Add sign-off requirement** - All commits must include
"Signed-off-by:" line using `git commit -s`
2. **Add PR title format** - Document the `[Type][Module] Description`
format for PR titles
3. **Add PR template reference** - Guide contributors to follow
`.github/PULL_REQUEST_TEMPLATE.md`
4. **Add linting check step** - Require running `bash format.sh ci`
before pushing
5. **Add lint note for all file types** - Emphasize markdown files also
need lint checking
6. **Add fork workflow guidance** - Clarify to push to fork repository,
not main repository
7. **Clarify test section** - Provide specific examples for "How was
this patch tested?"
8. **Add vLLM version note** - Warn about preserving auto-added vLLM
version info

### Does this PR introduce _any_ user-facing change?

No. This is a documentation-only update for contributors.

### How was this patch tested?

- Verified the markdown formatting renders correctly
- Confirmed all links and references are valid
- Ran `bash format.sh ci` locally and all checks passed

---

- vLLM version: v0.16.0
- vLLM main:
15d76f74e2

---------

Signed-off-by: realliujiaxu <realliujiaxu@163.com>
This commit is contained in:
realliujiaxu
2026-03-02 16:44:59 +08:00
committed by GitHub
parent 9180dd6c51
commit 8547520726
1 changed files with 54 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
AGENTS.md
View File

@@ -270,12 +270,20 @@ Reviewers must verify:
### Commit Message Format
Follow the [Conventional Commits](https://www.conventionalcommits.org/) format:
Follow the [Conventional Commits](https://www.conventionalcommits.org/) format and **must include a sign-off**:
```bash
git commit -s -m "<type>: <summary>" -m "<body - explaining what changed and why>"
```
Or using the full message format:
```txt
<type>: <summary>
<body - explaining what changed and why>
Signed-off-by: Your Name <your.email@example.com>
```
**Valid Types**: `feat`, `fix`, `perf`, `refactor`, `test`, `docs`, `chore`
@@ -307,6 +315,33 @@ add feature
update code
```
### Pull Request Title Format
PR titles should follow the format: `[Type][Module] Description`
- **Type**: The type of change (e.g., `CI`, `Doc`, `Bugfix`, `Feat`, `Platform`, `Refactor`)
- **Module**: The affected module (optional, e.g., `Misc`, `Model`, `Worker`)
- **Description**: Brief description of the change
**Examples:**
- `[Doc][Misc] Update contribution guidelines`
- `[Bugfix] Fix CPU binding logic`
- `[CI] Update image build workflow`
### Pull Request Template
When creating a PR, please follow the template in `.github/PULL_REQUEST_TEMPLATE.md` and ensure the following sections are completed:
> **Note**: The PR description will be automatically updated by GitHub Actions to include vLLM version info at the bottom. If you update the PR description via API or CLI, make sure to preserve the `- vLLM version:` and `- vLLM main:` lines.
- **What this PR does / why we need it?** - Clearly describe the changes and their purpose
- **Does this PR introduce _any_ user-facing change?** - Indicate if there are any user-visible changes
- **How was this patch tested?** - Describe how you tested the changes. Examples:
- Unit tests added/updated: list the test files
- Manual testing: provide the test steps and commands
- CI testing: indicate if only CI verification is needed
---
## Review Checklist
@@ -341,8 +376,10 @@ Before merging, verify:
### Commit and PR
- [ ] Commit messages are clear and descriptive
- [ ] PR description is complete
- [ ] Commit messages are clear and descriptive, following Conventional Commits format
- [ ] **All commits are signed off** (`git commit -s`)
- [ ] PR is created from your fork repository, not directly from the main repository
- [ ] PR description is complete, following the PR template
- [ ] All review comments addressed
---
@@ -356,7 +393,20 @@ Before merging, verify:
5. Make your changes following guidelines in this document
6. Add tests for new behavior
7. Run full test suite before committing
8. Create a PR with clear description
8. Commit with sign-off: `git commit -s`
9. Run linting check before pushing:
```bash
bash format.sh ci
```
> **Note**: This check is required for **all file types**, including markdown files. If `markdownlint` modifies files, re-add them with `git add` and commit again.
10. Push to your fork repository (NOT the main repository):
```bash
git remote add myfork https://github.com/YOUR_USERNAME/vllm-ascend.git
git push -u myfork your-branch-name
```
11. Create a PR from your fork to the main repository with clear description
---