We welcome contributions to Primus! To make the process smoother and more organized, please follow the guidelines below.
Please follow this branch naming convention for all feature and bug fix branches:
<type>/<scope>/<short-description>
| Type | Purpose |
|---|---|
feat |
New feature or functionality |
fix |
Bug fix |
docs |
Documentation update |
refactor |
Code refactoring (no functionality change) |
test |
Tests and test-related changes |
chore |
Miscellaneous changes (e.g., build scripts) |
ci |
Continuous integration-related changes |
The scope can be used to specify which part of the project is affected, for example: engine, model, scheduler, docs, tests, config.
feat/model/implement-moe-routing
fix/engine/init-error
docs/readme-add-moe-example
refactor/scheduler/remove-dead-code
We follow Conventional Commits for commit messages. Example:
feat(model): add MOE routing functionality
fix(engine): resolve initialization error
docs(readme): add MOE model example
This format helps us to automatically generate changelogs and provide more clarity in versioning.
- Fork the repository (if you don't have write access).
- Create a branch for your work following the branch naming convention described above.
- Make your changes and commit them following the commit message convention.
- Push your changes to your fork or branch in the repository.
- Create a pull request with a clear description of the changes, and reference any related issues.
- Add appropriate reviewers to the PR.
- Wait for the review and make any requested changes.
- Once approved, your PR will be merged.
Thank you for contributing!