Skip to content

Latest commit

 

History

History
19 lines (11 loc) · 1.02 KB

File metadata and controls

19 lines (11 loc) · 1.02 KB

Go Project Style Guide

This style guide outlines the best practices to ensure consistency and readability across the codebase.

ComplyTime Organization Style Guide

Refer to Style Guide, this is the universal style guide that all projects under the ComplyTime Organization should follow.

Project Style Guide

Code Formatting

  • Braces: Place opening braces on the same line as the statement (e.g., if, for, func).

Additional Guidelines

  • Other Go checks are present in CI/CD and therefore it may be useful to also run them locally before submitting a PR.
  • The pre-commit and pre-push hooks can be configured by installing pre-commit and running make dev-setup
  • Complyctl leverages the charmbracelet/log library for logging all command and provider activity. By default, this output is printed to stdout.