Gap: Code Style Guide & Contributing Guidelines

Status: 🔴 Not Started Priority: Important (Pre-Scale) Estimated Effort: 1-2 days

What's Missing

Code standards and contribution guidelines including:

• Go Style Conventions

  • Naming conventions (beyond Go stdlib)
  • Package organization
  • File naming
  • Function/method organization within files
  • Comment requirements

• Code Patterns

  • Repository pattern examples
  • Service layer patterns
  • Handler patterns
  • Error handling patterns
  • Testing patterns

• Database Conventions

  • Table naming
  • Column naming
  • Index naming
  • Migration file naming
  • RLS policy naming

• Git Workflow

  • Branch naming (feature/, bugfix/, hotfix/)
  • Commit message format
  • When to squash vs. merge
  • Rebase policy

• Pull Request Process

  • PR title format
  • PR description template
  • Required reviewers
  • CI checks required
  • Merge requirements

• Code Review

  • Review checklist
  • What to look for
  • How to provide feedback
  • Review turnaround expectations

• Documentation Requirements

  • When to update docs
  • Godoc comment requirements
  • README updates
  • API doc updates

Why Important

1. Code Consistency - Easier to read and maintain
2. Team Efficiency - Reduce bikeshedding
3. Onboarding - New developers follow patterns
4. Code Quality - Standards prevent common mistakes

Current State

• Architecture patterns documented
• No explicit style guide
• No contribution guidelines
• No PR template

Recommended Location

Root directory files:

• CONTRIBUTING.md - How to contribute
• CODE_STYLE.md - Code style guide

Also:

• .github/PULL_REQUEST_TEMPLATE.md - PR template
• docs/standards/code-review.md - Review guidelines

Success Criteria

• [ ] Go style conventions documented
• [ ] Database naming conventions defined
• [ ] Git workflow documented
• [ ] PR template created
• [ ] Code review checklist created
• [ ] Documentation requirements specified
• [ ] Team reviews and approves standards