Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 910 Bytes

File metadata and controls

35 lines (26 loc) · 910 Bytes

Commit Message Requirements for the Python SDK

At the Python SDK we require commits to be descriptive and conventionally named in order to keep helpful records.

Descriptive Commits

A descriptive commit is one that summarises in words what was just commited.

This is correct:

git commit -S -s -m "fix: fixed receipt status error catching in get_name"

This is incorrect:

git commit -S -s -m "looks like its mostly working now"

Conventional Commits

Read about conventional commit messages here: Conventional Commits

This is correct:

git commit -S -s -m "chore: changelog entry to TokenCreateTransaction"

This is incorrect:

git commit -S -s -m "feat: changelog entry to TokenCreateTransaction"

This is incorrect:

git commit -S -s -m "changelog entry to TokenCreateTransaction"