engineering-handbook/README.md

# Engineering Handbook

Engineering conventions and best practices for Sea Haven Industries.

## Contents

- [Naming Conventions](naming-conventions.md) -- kebab-case everywhere, no exceptions
- [Git Workflow](git-workflow.md) -- feature branches, incremental commits, deploy-then-merge
- [Commit Messages](commit-messages.md) -- imperative mood, 50/72 rule, explain "why"
- [Pull Requests](pull-requests.md) -- scope, title, description format, merge strategy
- [Code Review](code-review.md) -- what to look for, giving feedback, turnaround expectations
- [GitHub Standards](github-standards.md) -- branch defaults, repo hygiene, Dependabot
- [AWS Infrastructure](aws-infrastructure.md) -- SAM vs CDK, Lambda defaults, CloudFormation
- [SAM Project Layout](sam-project-layout.md) -- standard directory structure for serverless projects
- [Secrets and Configuration](secrets-and-config.md) -- Secrets Manager vs SSM Parameter Store
- [CI/CD Pipelines](cicd.md) -- every deployable repo gets a pipeline, no manual deploys

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

This work is licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). The commit messages section adapts content from [commit-messages-guide](https://github.com/RomuloOliveira/commit-messages-guide) by Romulo Oliveira, also licensed under CC-BY-4.0.
Add engineering handbook Conventions covering naming, git workflow, commit messages, pull requests, code review, GitHub standards, AWS infrastructure, SAM project layout, and secrets management. Commit messages section adapted from RomuloOliveira/commit-messages-guide (CC-BY-4.0). 2026-05-02 16:42:44 -04:00			`# Engineering Handbook`

			`Engineering conventions and best practices for Sea Haven Industries.`

			`## Contents`

			`- [Naming Conventions](naming-conventions.md) -- kebab-case everywhere, no exceptions`
			`- [Git Workflow](git-workflow.md) -- feature branches, incremental commits, deploy-then-merge`
			`- [Commit Messages](commit-messages.md) -- imperative mood, 50/72 rule, explain "why"`
			`- [Pull Requests](pull-requests.md) -- scope, title, description format, merge strategy`
			`- [Code Review](code-review.md) -- what to look for, giving feedback, turnaround expectations`
			`- [GitHub Standards](github-standards.md) -- branch defaults, repo hygiene, Dependabot`
			`- [AWS Infrastructure](aws-infrastructure.md) -- SAM vs CDK, Lambda defaults, CloudFormation`
			`- [SAM Project Layout](sam-project-layout.md) -- standard directory structure for serverless projects`
			`- [Secrets and Configuration](secrets-and-config.md) -- Secrets Manager vs SSM Parameter Store`
Add CI/CD pipeline requirements page (#5) Every deployable repo must have a pipeline — no manual deploys to production. 2026-05-08 13:56:25 -04:00			`- [CI/CD Pipelines](cicd.md) -- every deployable repo gets a pipeline, no manual deploys`
Add engineering handbook Conventions covering naming, git workflow, commit messages, pull requests, code review, GitHub standards, AWS infrastructure, SAM project layout, and secrets management. Commit messages section adapted from RomuloOliveira/commit-messages-guide (CC-BY-4.0). 2026-05-02 16:42:44 -04:00
			`## Contributing`

			`See [CONTRIBUTING.md](CONTRIBUTING.md).`

			`## License`

			`This work is licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). The commit messages section adapts content from [commit-messages-guide](https://github.com/RomuloOliveira/commit-messages-guide) by Romulo Oliveira, also licensed under CC-BY-4.0.`