Skip to content

Commit 6818770

Browse files
rebel-jiwooparkrebel-jiwoopark
authored
update(docs): update CONTRIBUTING and PR Template (#40)
1 parent 0c76830 commit 6818770

2 files changed

Lines changed: 136 additions & 30 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 48 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,21 @@
1-
### 🚀 Pull Request Summary
1+
<!--
2+
Thank you for contributing to vllm-rbln! 🚀
3+
This template will help us understand and review your pull request efficiently.
4+
Please fill out all required sections. You may delete optional ones if not applicable.
5+
see: https://github.com/rebellions-sw/vllm-rbln/blob/main/CONTRIBUTING.md
6+
-->
7+
8+
### 🚀 Summary of Changes
9+
10+
<!--
11+
**PR Title** uses the **Conventional Commits v1.0** format for the title.
12+
see: https://www.conventionalcommits.org/en/v1.0.0/
13+
14+
Examples:
15+
feat(core): support V1 engine
16+
fix(model): get num_gpu_blocks logic in V1
17+
docs: clarify usage of tensor parallel
18+
-->
219

320
<!-- Describe your changes in detail -->
421

@@ -8,25 +25,28 @@
825

926
### 📌 Related Issues / Tickets
1027

11-
* Fixes #
28+
<!--
29+
All pull requests must be linked to a Development-related Issue.
30+
Use "Resolves/Fixes/Closes/Related to #<issue_number>" to auto-link or close the issue when merged.
31+
-->
32+
33+
* Resolves #
1234
* Related to #
1335

1436
---
1537

16-
### ✅ Changes
38+
### ✅ Type of Change
1739

18-
* [ ] Feature
19-
* [ ] Bug Fix
20-
* [ ] Documentation
21-
* [ ] Refactor
22-
* [ ] Optimization
23-
* [ ] Other (please describe):
24-
25-
---
26-
27-
### 📸 Screenshots / Logs (if applicable)
40+
<!-- Mark all that apply using [x]. -->
2841

29-
<!-- Add before/after screenshots, terminal output, or logs -->
42+
* [ ] ✨ Feature (`feature`)
43+
* [ ] 🧠 Model support (`model`)
44+
* [ ] 🧬 Core engine changes (`core`)
45+
* [ ] 🛠 Bug fix (`bug-fix`)
46+
* [ ] ⚙️ Performance improvement (`perf`)
47+
* [ ] 🔁 Refactor or code cleanup (`refactor`)
48+
* [ ] 📄 Documentation (`docs`)
49+
* [ ] ❓ Other (`other`): please describe
3050

3151
---
3252

@@ -38,11 +58,22 @@
3858

3959
---
4060

61+
### 📸 Screenshots / Logs (if applicable)
62+
63+
<!-- Add before/after screenshots, terminal output, or logs -->
64+
65+
---
66+
4167
### 📋 Checklist
4268

43-
* [ ] I’ve added unit tests or updated existing ones.
44-
* [ ] I’ve updated relevant documentation.
45-
* [ ] I’ve checked compatibility (e.g., hardware/backend/platform).
69+
<!--
70+
The PR will only be reviewed and considered for merge if the following are satisfied.
71+
-->
72+
73+
* [ ] PR title follows Conventional Commits format
74+
* [ ] This PR is linked to an existing issue
75+
* [ ] The test method is described, and the expected result is clearly stated
76+
* [ ] Relevant documentation has been updated (if applicable)
4677

4778
---
4879

‎CONTRIBUTING.md‎

Lines changed: 88 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,99 @@
1+
# Contributing to vllm-rbln
12

2-
## Contributing to `vllm-rbln`
3+
Welcome! 🎉 Thank you for your interest in contributing to **vllm-rbln**, a plugin extension for the[vLLM project](https://github.com/vllm-project/vllm). As an open-source project, we rely on the support and involvement of the community to help make this project better for everyone. This document outlines our contribution process, coding guidelines, and community standards.
34

4-
Thank you for your interest in contributing to `vllm-rbln`! As an open-source project, we rely on the support and involvement of the community to help make this project better for everyone.
5+
We value transparency, collaboration, and a safe environment for contributors. All contributions are expected to follow these guidelines.
56

6-
### 💡 How You Can Contribute
7+
------
78

8-
There are many valuable ways to contribute:
9+
## Getting Started
910

10-
* **Ideas & Feedback**: Share your thoughts on how to improve the project or suggest new features.
11-
* **Bug Reports**: Help us identify and fix issues by reporting bugs with clear reproduction steps.
12-
* **Feature Proposals**: Suggest enhancements or new functionality that would benefit the community.
13-
* **Code Contributions**: Submit pull requests to fix bugs, implement new features, or improve existing logic.
14-
* **Documentation Improvements**: Clarify usage instructions, fix typos, or expand on examples.
15-
* **Testing & Validation**: Help test new releases or verify fixes across different environments.
16-
* **Community Support**: Answer questions, share your experience, or guide others in discussions.
11+
### Contributors
1712

18-
### 🛠️ Getting Started
13+
1. **Fork the repository** and create your branch from main.
14+
2. Make your changes with clear and concise commits.
15+
3. Ensure that your code follows the style and linting rules.
16+
4. If relevant, update or add new tests and documentation.
17+
5. Open a pull request with a detailed description of your changes.
1918

20-
1. **Fork the repository** and create your branch from `main`.
19+
### Core Contributors & Collaborators
20+
21+
1. **Create your branch** and work on branches within the repository.
2122
2. Make your changes with clear and concise commits.
2223
3. Ensure that your code follows the style and linting rules.
2324
4. If relevant, update or add new tests and documentation.
2425
5. Open a pull request with a detailed description of your changes.
26+
27+
All contributors must use **English** for issues, comments, and code.
28+
29+
------
30+
31+
## 💡 How You Can Contribute
32+
33+
One of the best ways to contribute to the project is by creating issues — whether you're reporting a bug, suggesting a new idea, implementing nice features, or asking a question.
34+
35+
If you’ve found something that needs attention or improvement, we’d love to hear from you!
36+
Your input helps us make **vllm-rbln** better for everyone.
37+
38+
When creating an issue, please provide as much detail as possible and select the appropriate label to help us triage and respond efficiently. 🙏
39+
40+
### General Issue
41+
42+
These issues are used to discuss general suggestions, requests, bug reports, and other topics.
43+
44+
- proposal: Suggest enhancements or new functionality that would benefit the vllm-rbln.
45+
- request: Request a specific development task that you think should be implemented.
46+
- bug: Help us identify and fix issues by reporting bugs with clear reproduction steps.
47+
- question: Ask general questions about using the project, understanding behavior, or seeking clarification. Ideal for newcomers or anyone unsure about how something works.
48+
- discussion: Start open-ended conversations about design decisions, optimization features, etc. Useful for gathering community feedback before moving to a proposal.
49+
- help wanted: Highlight tasks where contributor support is requested. Often used in combination with other labels like bug or question.
50+
51+
### Development-related Issue
52+
53+
These issue types represent development tasks that are typically addressed through pull requests.
54+
55+
- feature: Develop a new capability or functionality in the codebase. Should be scoped and accompanied by acceptance criteria or use cases if possible.
56+
- model: Issues related to adding, modifying, or improving support for specific ML models. Include model details (e.g., architecture).
57+
- core: Changes that impact core engine components such as worker, model runner, scheduler, memory management, or plugin infrastructure. These usually require in-depth review and testing.
58+
- bug-fix: Tracks the resolution of known bugs.
59+
- perf: Implement improvements focused on performance, such as latency reduction, memory usage, or throughput. Include benchmarks or measurement methodology if available.
60+
- refactor: Improve readability, maintainability, or consistency without altering external behavior. Includes renaming, code modularization, or dependency cleanup.
61+
- docs: Improve or add to documentation. Includes README, usage guides, code comments, and tutorial examples. Helpful for improving project onboarding and understanding.
62+
- other: Any development-related task that doesn't fit the above categories. Use this label sparingly, and consider proposing a new label if recurring themes emerge.
63+
64+
Please choose labels appropriately when opening an issue.
65+
66+
------
67+
68+
## Pull Request Guidelines
69+
70+
All pull requests **must**:
71+
72+
- Have a corresponding issue: refer to Development-related Issue
73+
- Include a clear title following[**Conventional Commits v1.0**](https://www.conventionalcommits.org/en/v1.0.0).
74+
- Contain the following in the description:
75+
- Purpose and detailed explanation
76+
- Related issue number
77+
- Affected modules (e.g., Platform, Worker, Runner, Attn, Models, optimum)
78+
- Type of change (use Labels): Feature / Bug Fix / Refactor / ....
79+
- Describe How to Test and a summary of expected results
80+
81+
💡 Individual commit messages in PR branches do not need to strictly follow Conventional Commits, but should remain readable and descriptive.
82+
83+
------
84+
85+
## Merge Policy
86+
87+
All of the following must be satisfied for a PR to be merged:
88+
89+
- ✅ All CI tests must pass
90+
- ✅ At least one approval from the relevant team
91+
- ✅ Allow only **Squash and merge**
92+
93+
------
94+
95+
## 🙌 Thank You
96+
97+
Thank you for taking the time to contribute to **vllm-rbln**!
98+
Whether you're submitting a pull request, opening an issue, improving documentation, or simply asking thoughtful questions — your effort helps strengthen the project and the community around it.
99+
We believe that great software is built in the open, by people who care. We're excited to have you on board, and we look forward to your contributions. 🚀

0 commit comments

Comments
 (0)