2026-09-27 01:58:05 +00:00
# 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 |
2026-09-27 02:23:06 +00:00
| Sentry | Error monitoring, logs, tracing, metrics, and privacy rules |
2026-09-27 01:58:05 +00:00
## 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.
2026-09-27 02:23:06 +00:00
3. PR title should end with its Jira key, for example `feat(api): add receipt search (DEV-123)` .
2026-09-27 01:58:05 +00:00
4. Never put secrets in code, environment variables, `.env` files in git, tickets, chat, or wiki pages.
2026-09-27 02:23:06 +00:00
5. AWS resources are created by infrastructure as code. Nothing is built by hand in the console.
2026-09-27 01:58:05 +00:00
6. Nobody deploys from a laptop. The pipeline deploys.
## Questions and changes
2026-09-27 02:23:06 +00:00
Ask your technical point of contact. To propose a change to these standards, open a Jira ticket in the matching project (see Issue Tracking).
