Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 2.57 KB

File metadata and controls

63 lines (39 loc) · 2.57 KB

Technical Conventions



📚 Convention Categories

🚀 Core Development

Go Essentials Non-negotiable Go development practices including context-first design, interface philosophy, goroutine discipline, error handling, and performance guidelines.

Testing Standards Comprehensive testing guidelines covering unit tests, table-driven tests, fuzz testing, code coverage requirements, and testing best practices.

Commenting & Documentation Standards for code comments, function documentation, package-level docs, Markdown formatting, and maintaining clear, purposeful documentation.



🔄 Version Control & Collaboration

Commit & Branch Conventions Git commit message format, branch naming standards, and version control best practices for maintaining clean repository history.

Pull Request Guidelines Structured approach to creating and reviewing pull requests, including required sections, review etiquette, and merging strategies.

Release Workflow & Versioning Semantic versioning practices, release tooling with goreleaser, changelog management, and automated release processes.



🏷️ Project Management

Labeling Conventions GitHub label system for categorizing issues and PRs, including standard labels, usage guidelines, and automated labeling.

🤖 AI Usage & Assistant Guidelines

AI Compliance Guide to AI assistant configuration files and where to find standards for AI-assisted development.



🔧 Infrastructure & Quality

Dependency Management Go modules management, security scanning, version control practices, and maintaining healthy dependencies.

Security Practices Security-first development, vulnerability reporting, security tools, and following OpenSSF best practices.

Pre-commit Hooks Pure Go pre-commit framework with 17x faster execution than Python alternatives, providing automated code quality checks.

GitHub Workflows Development Creating and maintaining GitHub Actions workflows with security, reliability, and performance in mind.



🏗️ Build & Project Setup

MAGE-X Build Tooling Zero-boilerplate build toolchain with 150+ built-in commands that replaces Makefiles. Includes installation, configuration, command reference, and migration guide.