mirror of
https://github.com/Sea-Haven-Industries/engineering-handbook.git
synced 2026-10-02 10:53:16 +00:00
735b407017
Partner engineering teams need the standards without access to this repo, which contains internal repo names, account identifiers, and migration history. Adds eight simplified pages, one per Confluence page, plus an internal README with source mapping and exclusions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UP6j3hYgoVqjKZwC3XB9ay
30 lines
1.4 KiB
Markdown
30 lines
1.4 KiB
Markdown
# 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 |
|
|
|
|
## 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. Every PR title ends 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. Every AWS resource is 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 Sea Haven point of contact. To propose a change to these standards, open a Jira ticket in the matching project (see Issue Tracking).
|