While bug fixes can first be identified via an "issue", that is not required. It's ok to just open up a PR with the fix, but make sure you include the same information you would have included in an issue - like how to reproduce it.
PRs for new features should include some background on what use cases the new code is trying to address. When possible and when it makes sense, try to break-up larger PRs into smaller ones - it's easier to review smaller code changes. But only if those smaller ones make sense as stand-alone PRs.
Regardless of the type of PR, all PRs should include:
- well documented code changes;
- additional testcases: ideally, they should fail w/o your code change applied;
- documentation changes.
Squash your commits into logical pieces of work that might want to be reviewed separate from the rest of the PRs. Ideally, each commit should implement a single idea, and the PR branch should pass the tests at every commit. GitHub makes it easy to review the cumulative effect of many commits; so, when in doubt, use smaller commits.
This project tries to follow CRIU's commit message conventions, although they are not strictly enforced. For guidance on writing clear and effective commit messages, see How to Write a Git Commit Message.
PRs that fix issues should include a reference like Closes #XXXX in the
commit message so that github will automatically close the referenced issue
when the PR is merged.
PRs are checked for binary size increases. If a PR legitimately increases
the binary size beyond the default threshold, a maintainer can add the
bloat-ok label to bypass the size check.
Contributors must assert that they are in compliance with the Developer Certificate of Origin 1.1. This is achieved by adding a "Signed-off-by" line containing the contributor's name and e-mail to every commit message. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch.
The use of AI tools is welcome but should be correctly attributed, especially for substantial changes. You can use one of the following in your commit message:
Assisted-by: <AI tool>Co-authored-by: <AI tool>Generated-by: <AI tool>- Or mention it in the commit message body, e.g., "Generated with "
Marking AI-assisted contributions helps preserve both legal clarity and community trust, and makes it easier for reviewers to evaluate the code in context. For more information, see AI-assisted development and open source: Navigating the legal issues.