Contributing#
Commit message convention#
Every commit subject line must start with one of these prefixes followed by a space:
Prefix |
Meaning |
|---|---|
|
Bug fix |
|
Refactoring |
|
New feature |
|
Addresses backward-compatibility |
|
Optimization |
|
Continuous integration |
|
Maintenance (release prep, dependency bumps, etc.) |
|
Documentation |
|
Adding or changing tests |
|
Whitespace / formatting - no logic change |
|
Work in progress, not ready to merge |
Additional rules:
Subject line: minimum 15 characters, maximum 78 characters.
No trailing period on the subject line.
Second line, if present, must be blank.
To reference an issue add
Issue #XXXXto the PR description.To close an issue add
Closes #XXXXto the PR description.
Examples:
NF: add VTK v5.1 reader support
BF: fix int32 overflow in PLY binary writer
TEST: add roundtrip tests for OBJ multi-group tags
DOC: document lazy loading behaviour for binary VTK
The commit message hook runs automatically via pre-commit. Install it
once with:
pip install pre-commit
pre-commit install --hook-type commit-msg