PR and commit message guidelines

Jump to bottom

Yang Yang edited this page Jun 2, 2020 · 2 revisions

The PR branch name should be short and dash(-) sperated lower case string which could reflect the content of the PR best.

The commit message should be ruled as Conventional Commits. We are mainly using types below:

feat: A new feature
fix: A bug fix
refactor: A code change that neither fixes a bug nor adds a feature
test: Adding missing tests or correcting existing tests
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
docs: Documentation only changes
chore: Other stuff
tools: Tools related changes (build/push/test)

The scopes are:

launcher: Inside utils container
xudctl: Inside utils container too. A self-crafted bash-like shell written in python.
image: Image related stuff

Examples:

feat(image): upgrade xud to 1.0.0-beta.3