Contributing

This chapter is the entry point for contributing. Read it before submitting a patch, and use the checklist at the end of this page to review the change.

In this chapter

• Workflow
• Add a vHost image recipe
• Patch check
• Maintainers
• CI
• Rust guidelines
• Documentation rules

Recommended path

• First contribution: read Workflow, then Patch check

• New guest distribution or image variant: read Add a vHost image recipe

• Rust changes: also read Rust guidelines

• Documentation changes: read Documentation rules and run just docs-check

• To find the reviewers: see Maintainers

Before you submit

• Every non-merge commit passes just check-patch

• Each commit carries a Signed-off-by: line and no AI attribution trailers

• New files belong to an existing area in MAINTAINERS.yml, or add one in the same commit

• When a change touches both languages, update the Chinese and English pages in the same commit

Related pages

• Workflow

• Patch check

• Documentation rules

• Getting Started