Files
xc-llm-kunlun/CONTRIBUTING.md
tanjunchen 0efa514bd9 1.add CODE_OF_CONDUCT.md to vLLM Kunlun
2.add MAINTAINERS.md to vLLM Kunlun
3.add MAINTAINERS.md to vLLM Kunlun
4.add contributing guide to vLLM Kunlun

Signed-off-by: tanjunchen <tanjunchen20@gmail.com>
2025-12-27 19:50:12 +08:00

3.0 KiB

Contributing to vLLM Kunlun

Welcome to vLLM Kunlun! We warmly welcome community contributions. Feel free to report issues or submit pull requests. Before getting started, we highly recommend reading the Contributing Guide below.

Contributing

Please refer to the CONTRIBUTING guide for detailed instructions. It provides a step-by-step guide on how to set up the development environment, build the project, and run tests.

Issues

We use GitHub Issues to track bugs, feature requests, and other public discussions.

Search Existing Issues First

Before opening a new issue, please search through existing issues to check whether a similar bug report or feature request already exists. This helps avoid duplicates and keeps discussions focused.

Reporting New Issues

When opening a new issue, please provide as much information as possible, such as:

  • A clear and detailed problem description
  • Relevant logs or error messages
  • Code snippets, screenshots, or videos if applicable

The more context you provide, the easier it will be for maintainers to diagnose and resolve the issue.

Pull Requests

We strongly welcome pull requests to help improve vLLM Kunlun.

Submitting Pull Requests

All pull requests will be reviewed by the maintainers. Automated checks and tests will be run as part of the review process. Once all checks pass and the review is approved, the pull request will be accepted. Please note that merging into the main branch may not happen immediately and could be subject to scheduling.

Before submitting a pull request, please make sure that:

  1. You fork the repository and create your branch from main.
  2. You update relevant code comments or documentation if APIs are changed.
  3. You add the appropriate copyright notice to the top of any new files.
  4. Your code passes linting and style checks.
  5. Your changes are fully tested.
  6. You submit the pull request against the development branch as required.

License

By contributing to vLLM Kunlun, you agree that your contributions will be licensed under the Apache License 2.0.