Maintainer Guide

Resources for maintaining and contributing to Gamma projects.

Documentation

All Gamma projects share consistent documentation styling through reusable GitHub Actions hosted in this repository.

Shared Docs Setup

Project Standards

Repository Structure

Every Gamma project should follow this structure:

your-project/
├── .github/
│   └── workflows/
│       └── docs.yml          # Documentation workflow
├── docs/
│   ├── index.md              # Project homepage
│   └── ...                   # Additional docs
├── mkdocs.yml                # Navigation config
├── go.mod
├── go.sum
├── README.md
└── LICENSE

Documentation Requirements

• Every public function, type, and method should have GoDoc comments
• Include usage examples in documentation
• Provide a clear README with installation and quick start

Testing Standards

• Minimum 80% code coverage
• All tests must pass with race detector enabled
• Include benchmarks for performance-critical code

Versioning

We follow Semantic Versioning:

• MAJOR — Breaking API changes
• MINOR — New features, backward compatible
• PATCH — Bug fixes, backward compatible

Contributing

See the Contributing Guide for how to contribute to Gamma projects.