This document provides an overview of contributing to the SigNoz backend written in Go. The SigNoz backend is built with Go, focusing on performance, maintainability, and developer experience. We strive for clean, idiomatic code that follows established Go practices while addressing the unique needs of an observability platform.

We adhere to three primary style guides as our foundation:

Effective Go - For writing idiomatic Go code
Code Review Comments - For understanding common comments in code reviews
Google Style Guide - Additional practices from Google

We recommend (almost enforce) reviewing these guides before contributing to the codebase. They provide valuable insights into writing idiomatic Go code and will help you understand our approach to backend development. In addition, we have a few additional rules that make certain areas stricter than the above which can be found in area-specific files in this package:

Abstractions - When to introduce new types and intermediate representations
Errors - Structured error handling
Endpoint - HTTP endpoint patterns
Flagger - Feature flag patterns
Handler - HTTP handler patterns
Integration - Integration testing
Provider - Dependency injection and provider patterns
Packages - Naming, layout, and conventions for pkg/ packages
Service - Managed service lifecycle with factory.Service
SQL - Database and SQL patterns