Skip to content

Repository Standards

Mandatory standards

  • Each product or shared component should have a clear repository boundary
  • Repository structure should make ownership, build inputs, tests, and deployment paths easy to find
  • Generated artifacts should not be treated as source unless the repository explicitly documents that choice
  • The default branch and release flow should be documented for each repository
  • Repository changes should be reviewable and attributable

GitLab alignment

PotatoLabs repositories are expected to work with GitLab CE and GitLab CI/CD as the platform capabilities provided by PMP-001.

  • Keep repository roots tidy
  • Store reusable scripts in predictable locations
  • Make README or equivalent entry pages point to the most important developer and operator instructions
  • Avoid hidden setup steps that only one person understands

Configuration and environment management

  • Configuration values should be externalized when they vary by environment
  • Environment-specific settings should be documented
  • Runtime defaults should be safe and explicit