Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 1.66 KB

COMMIT_FORMAT_EXAMPLES.md

File metadata and controls

69 lines (48 loc) · 1.66 KB

Commit Message Examples

Chores

A chore type is a task not directly tied to a feature, fix, or test. It is often work that requires no change to production code.

chore(scripts/): Moved extraneous scripts into scripts/ directory

Documentation

A docs type is a task that directly effects documentation that is constructed manually, programmatically, or through a third-party. This can include typos, additions, deletions, and examples.

docs(allocator.h): Document prototypes

Features

A feat type is a task that introduces a new feature. The new feature may introduce a breaking change to production code.

feat(storage.c): Introduce new random access storage operation

Fixes/bugs

A fix type is a task that addresses a bug in production code, build scripts, compilation steps, or anything that directly or indirectly breaks or impacts production.

fix(request.c): Fix double free

Refactoring

A refactor type is a task that changes existing code. A refactor should be an improvement to the existing production code.

refactor(platform.h): Simplify macro ifdef logic for platform includes

Code style

A style type is a task that addresses code formatting such as missing semicolons, converting tabs to spaces, or removing extra newlines. There should not be any code changes.

style(sleepfile.h): Convert tabs to spaces

Tests

A test type is a task that addresses the testing of production code. This may include adding a new or missing test, refactoring existing tests, or removing useless tests. There should not be any code changes.

test(test.c): Enhance code path coverage