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 NormativeCO01110

Code Generation - SQLC NormativeCO01115

Code Generation - OAPI NormativeCO01120

Generated Docs NormativeCO01210

Written Docs NormativeCO01215

.Buildkite Folder NormativeCO01310

Cmd Folder NormativeCO01315

Internal Packages NormativeCO01320

Exported Packages NormativeCO01325

.Env Files NormativeCO01330

Required DotFiles NormativeCO01335

Ignored DotFiles NormativeCO01340

Main.go NormativeCO01390

Creating Packages NormativeCO01410

Avoiding Circular Imports NormativeCO01420

Splitting Existing Packages NormativeCO01425

Versioning API Packages NormativeCO01470

Versioning Client Packages NormativeCO01471

Versioning Legacy Packages NormativeCO01475