IMTAPPS Style Guides

commits.md

Commit Message Prefixes

If you are working on a change that has a ticket number, add it to the commit message!

All commits prefixed with Bug Fix, Feature or Enhancement will be communicated with a non-technical audience. In the rare scenario where you do NOT want to communicate one of the aforementioned commits add a [private] to the commit message. Commit messages with [private] will be communicated with technical audiences only and should match the following format.

Prefix: Here is the message

[private]

Bug Fix (Sent to Support)

• A fix for a bug

Feature (Sent to Support)

• Something that did not previously exist

Enhancement (Sent to Support)

• Something that previously existed, but now works slightly differently in some way

Doc

• Documentation

Tech Debt

• To be used when introducing tech debt
• Don't use this one

Version

• A new (semver) version number

Dependency

• Updating the dependencies
• Updating 3rd party APIs ect

Debugging

• Experimental code (print statements, logging, etc)

Refactor

• Improvements to code with no modification of external behavior
• Include Performance Enhancements

Test

• New tests or altering old tests without changing any production code
• Helper code intended to assist ONLY with test creation

Style

• Linting violations, code formatting, etc

Peripheral

• Updates to builds, deploys, etc

python.md

Follow Flake8 Standards

(as indicated in vim)

Imports

• Order imports as follows (include single blank line between following groups)
  • Imports from standard library
  • Imports from 3rd party libraries (including our own libraries)
  • Imports from local codebase