Organising

The rules in this section govern the organisation of Swoop’s code repository, and cover the topics of creating new packages, which files must or must not be included in repositories, where the source files for code generation should be placed, where the build-pipeline configuration files are located, and other sorting/organization principles.

Code Generation - DB Migrations Normative CO01110

Code Generation Sqlc Normative CO01115

Code Generation Oapi Normative CO01120

Generated Docs Normative CO01210

Written Docs Normative CO01215

.Buildkite Folder Normative CO01310

Cmd Folder Normative CO01315

Internal Packages Normative CO01320

Exported Packages Normative CO01325

.Env Files Normative CO01330

Required DotFiles Normative CO01335

Ignored DotFiles Normative CO01340

Main.go Normative CO01390

Creating Packages Normative CO01410

Avoiding Circular Imports Normative CO01420

Splitting Existing Packages Normative CO01425

Versioning API Packages Normative CO01470

Versioning Client Packages Normative CO01471

Versioning Legacy Packages Normative CO01475