Skip to content

General Guidelines

Jonathan Hoffstadt edited this page Oct 14, 2021 · 1 revision

Commit Messages

Commit messages will follow a modified version of the Conventional Commits Spec.

Format:

<type> [optional scope]: <description>

Types:

Type Description
fix A bug fix
feat A new feature
build Changes that affect the build system or external dependencies (imgui)
ci Changes to our CI configuration files and scripts (example scopes: setup.py, workflows)
chore updating grunt tasks etc; no production code change
docs Documentation only changes
style Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor A code change that neither fixes a bug nor adds a feature
perf A code change that improves performance
test Adding missing tests or correcting existing tests

Example

fix (mvButton): fix button double-click melting user's monitor