| Last change: |
Add annotations and enforce type hints
Add configurable prefix and suffix for accessors and mutators
Cleanup code
# |<---- Preferably using up to 50 chars --->|<------------------->|
# Example:
# Add feature for a user to like a post
# (Optional) Explain why this change is being made
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# (Optional) Provide links or keys to any relevant tickets, articles or other resources
# Example: Github issue #23
# (Optional) List all co-authors, so version control systems can connect teams.
# Example: Co-authored-by: Name <[email protected]>
# (Optional) Tags suitable for searching, such as hashtags, keywords, etc.
# Example: Tags: authentication, login, security
# --- COMMIT END ---
# === Remember to ===
# * Capitalize the subject line
# * Use the imperative mood in the subject line
# Imperative verbs usage:
# - Add = Create a capability e.g. feature, test, dependency.
# - Drop = Delete a capability e.g. feature, test, dependency.
# - Fix = Fix an issue e.g. bug, typo, accident, misstatement.
# - Bump = Increase the version of something e.g. a dependency.
# - Make = Change the build process, or tools, or infrastructure.
# - Start = Begin doing something; e.g. enable a toggle, feature flag, etc.
# - Stop = End doing something; e.g. disable a toggle, feature flag, etc.
# - Optimize = A change that MUST be just about performance, e.g. speed up code.
# - Document = A change that MUST be only in the documentation, e.g. help files.
# - Refactor = A change that MUST be just refactoring.
# - Reformat = A change that MUST be just format, e.g. indent line, trim space, etc.
# - Rephrase = A change that MUST be just textual, e.g. edit a comment, doc, etc.
# * Do not end the subject line with a period
# * Separate subject from body with a blank line
# * Use the body to explain what and why vs. how
# * Can use multiple lines with "-" or "*" for bullet points in body
# --------------------
# === Use semantic versioning ===
# - Add, Start: Increment SemVer MINOR version when there is a new capability.
# - Drop, Stop: Increment SemVer MAJOR version when there is an incompatibility.
# - Fix, Bump, Make, Optimize, Document: Increment SemVer PATCH version.
# - Refactor, Reformat, Rearrange, Redraw, Reword: Increment SemVer PATCH version.
# --------------------
# === Usage ===
# Put the template wherever you want.
# Example:
# ~/.gitmessage
#
# Configure git to use the template file by running:
# git config --global commit.template ~/.gitmessage && git config --global commit.cleanup strip
#
# Or manually add the template file to the ~/.gitconfig file:
# [commit]
# template = ~/.gitmessage
# cleanup = strip
# --------------------
:recycle: Refactor the buildMethodName function
# Explain why this change is being made
# Provide links to any relevant tickets, articles or other resources
:truck: Rename Transformer class
# Explain why this change is being made
# Provide links to any relevant tickets, articles or other resources
|
