Contributing

Commit Messages

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

<type> [optional scope]: <description>

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)
refac	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
revert	A revert

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

Branches should follow the following naming conventions:

Type	Format	Example	Description
Bug Fix	`bug/<issue number>-description`	`bug/37-fix-mouse`	Bug fix related work
Feature	`feature/<issue number>-description`	`feature/37-multi-viewport`	New features
Chore	`chore/<issue number>-description`	`chore/37-rename-files`	Styles, builds, ci, etc. Work without associated issue numbers.
Documentation	`docs/<issue number>-description`	`docs/37-drawing-api`	Documentation related work
Tests	`tests/<issue number>-description`	`tests/37-math-tests`	Test related work
Refactors	`refactor/<issue number>-description`	`refactor/37-rework-allocator`	Refactor related work
Builds	`build/<issue number>-description`	`build/37-cleanup-build`	Build related work
Demo	`demo/<issue number>-description`	`demo/37-rand-demo`	Demo related work
Experiment	`exp/<issue number>-description`	`exp/37-renderer-api`	Experimental work (not to be merged)