adam/engineering-handbook
1
0
Fork 0
mirror of https://github.com/Sea-Haven-Industries/engineering-handbook.git synced 2026-09-30 04:33:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
engineering-handbook/confluence/00-engineering-standards.md
Claude 56c0e76fd5
docs(confluence): add sentry standards page 
Partner teams need the Sentry setup and privacy rules, which only exist
in individual Jira tickets. Also syncs index wording edits already made
on the published Confluence page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UP6j3hYgoVqjKZwC3XB9ay
2026-09-27 02:23:06 +00:00

1.5 KiB
Raw Blame History

Engineering Standards

These pages describe how we build, review, and ship software at Sea Haven Industries. They apply to everyone who contributes code, including partner and contract teams.

Pages

Page Covers
Naming Conventions How to name repos, branches, and cloud resources
Git Workflow Branches, commits, versioning, and push rules
Pull Requests and Code Review PR titles and descriptions, review categories, merging
Issue Tracking Jira projects and the ticket template
Secrets and Configuration Where sensitive and non-sensitive values live
AWS Infrastructure Infrastructure as code, Lambda defaults, tagging
CI/CD and Deployments Pipelines, environments, releases, and rollback
Sentry Error monitoring, logs, tracing, metrics, and privacy rules

Core rules

If you read nothing else, follow these:

  1. Use kebab-case for every name.
  2. Never commit to main directly. Every change goes through a pull request.
  3. PR title should end with its Jira key, for example feat(api): add receipt search (DEV-123).
  4. Never put secrets in code, environment variables, .env files in git, tickets, chat, or wiki pages.
  5. AWS resources are created by infrastructure as code. Nothing is built by hand in the console.
  6. Nobody deploys from a laptop. The pipeline deploys.

Questions and changes

Ask your technical point of contact. To propose a change to these standards, open a Jira ticket in the matching project (see Issue Tracking).