styleguides.md

Developers: Style Guides with oc-mirror

• Developers: Style Guides with oc-mirror
• Git Commit Messages
• Code Formatting
• Docs Style

Git Commit Messages

• Use conventional commits guidelines

Code Formatting

• Use go fmt
• All code should be error-free when run through go vet.
• make sanity can also be run to check this.

Docs Style

• Use Markdown
• Always use a table of contents when there are multiple sections