add PULL_REQUEST_TEMPLATE.md and ISSUE_TEMPLATE

Signed-off-by: tanjunchen <tanjunchen20@gmail.com>
This commit is contained in:
tanjunchen
2025-12-27 22:03:56 +08:00
parent 45c6b8e927
commit 99269e3ce9
4 changed files with 227 additions and 0 deletions

View File

@@ -0,0 +1,60 @@
name: Feature Request
description: Propose a new feature or enhancement
labels: ["feature request"]
title: "feature: <short summary>"
body:
- type: markdown
attributes:
value: |
👋 **Thanks for taking the time to submit a feature request!**
Please help us understand your idea clearly by filling out the sections below.
Well-described proposals are easier to evaluate and more likely to be prioritized.
- type: textarea
attributes:
label: Feature Description
description: |
Describe the feature or enhancement you are proposing.
What should it do? What problem does it solve?
Please be as clear and specific as possible.
placeholder: |
Example:
- Add support for XXX
- Improve performance of YYY under ZZZ workload
validations:
required: true
- type: textarea
attributes:
label: Motivation / Use Case
description: |
Why do you need this feature?
Describe the real-world use case, workload, or scenario where this feature is important.
placeholder: |
Example:
- This feature is required to support large-scale inference
- Needed to reduce TTFT/TPOT under high concurrency
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: |
Add any additional context that may help us evaluate this request.
This can include design ideas, references, benchmarks, logs, or related issues/PRs.
placeholder: |
- Related issues or PRs
- Links to papers or docs
- Performance numbers or expected impact
validations:
required: false
- type: markdown
attributes:
value: |
👍 **Community feedback matters!**
If you find this proposal useful, feel free to give it a 👍.
We often prioritize feature requests with strong community interest.

View File

@@ -0,0 +1,74 @@
name: Bug Report
description: Report a bug or unexpected behavior
labels: ["bug"]
title: "bug: <short summary>"
body:
- type: markdown
attributes:
value: |
🐞 **Thanks for reporting a bug!**
To help us investigate and fix the issue efficiently, please provide as much
relevant information as possible. Clear and reproducible reports are highly appreciated.
- type: textarea
attributes:
label: Bug Description
description: |
Clearly and concisely describe the bug.
What happened? What is broken or behaving incorrectly?
placeholder: |
Example:
- vLLM crashes when loading model XXX
- Unexpected latency spike during decode stage
validations:
required: true
- type: textarea
attributes:
label: Steps to Reproduce
description: |
Provide the exact steps to reproduce the issue.
Please include commands, configuration, and minimal repro if possible.
placeholder: |
Example:
1. Start vLLM with config XXX
2. Send request YYY
3. Observe error or incorrect behavior
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: |
Describe what you expected to happen instead.
This helps clarify whether the behavior is incorrect or just unexpected.
placeholder: |
Example:
- Model should load successfully
- Latency should remain stable under N requests
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: |
Add any additional information that may help diagnose the issue.
This can include logs, stack traces, environment details, or related issues.
placeholder: |
- Logs / stack traces
- OS, CUDA, driver, hardware info
- vLLM / Kunlun version
- Related issues or PRs
validations:
required: false
- type: markdown
attributes:
value: |
👍 **Does this bug affect you as well?**
Please consider giving it a 👍.
We often prioritize issues that impact a larger portion of the community.

8
.github/ISSUE_TEMPLATE/099_config.yml vendored Normal file
View File

@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: 📘 Documentation & Tutorials
url: https://vllm-kunlun.readthedocs.io
about: |
Please check the official documentation and tutorials first.
Many common questions, usage examples, and best practices are covered there.