mirror of
https://github.com/Sea-Haven-Industries/engineering-handbook.git
synced 2026-09-30 11:33:13 +00:00
Engineering conventions and best practices for Sea Haven Industries
bf161add07
- Pin blessed aws-cdk-lib version (2.253.1) with upgrade procedure - Update Lambda runtime default from Node 22 to Node 24 - Rewrite CI/CD page to reflect GitHub Actions reusable workflows (was still referencing CodePipeline/CodeBuild) |
||
|---|---|---|
| aws-infrastructure.md | ||
| cicd.md | ||
| code-review.md | ||
| commit-messages.md | ||
| CONTRIBUTING.md | ||
| git-workflow.md | ||
| github-standards.md | ||
| LICENSE | ||
| naming-conventions.md | ||
| pull-requests.md | ||
| README.md | ||
| sam-project-layout.md | ||
| secrets-and-config.md | ||
Engineering Handbook
Engineering conventions and best practices for Sea Haven Industries.
Contents
- Naming Conventions -- kebab-case everywhere, no exceptions
- Git Workflow -- feature branches, incremental commits, deploy-then-merge
- Commit Messages -- imperative mood, 50/72 rule, explain "why"
- Pull Requests -- scope, title, description format, merge strategy
- Code Review -- what to look for, giving feedback, turnaround expectations
- GitHub Standards -- branch defaults, repo hygiene, Dependabot
- AWS Infrastructure -- SAM vs CDK, Lambda defaults, CloudFormation
- SAM Project Layout -- standard directory structure for serverless projects
- Secrets and Configuration -- Secrets Manager vs SSM Parameter Store
- CI/CD Pipelines -- every deployable repo gets a pipeline, no manual deploys
Contributing
See CONTRIBUTING.md.
License
This work is licensed under CC-BY-4.0. The commit messages section adapts content from commit-messages-guide by Romulo Oliveira, also licensed under CC-BY-4.0.