mirror of
https://github.com/Sea-Haven-Industries/engineering-handbook.git
synced 2026-09-30 03:23:14 +00:00
Engineering conventions and best practices for Sea Haven Industries
4b5d39fb91
* Update CDK version policy, Node 24 runtime, and GitHub Actions CI/CD - 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) * Add pre-push hook for npm ci validation Catches lock file drift locally before it breaks CI. Includes install instructions in git-workflow.md. * Add repo provisioning script Automates the new-repo checklist: GitHub repo creation, OIDC deploy role, repo secret, security features, CI/CD workflow stubs, and pre-push hook installation. Supports both SAM and CDK stack types. * Add shared VpnEc2Instance CDK construct Reference construct for the VPN-accessible EC2 pattern used by file-share and forgejo. Includes VPC/subnet lookup, SG, IAM role, encrypted EBS, and DLM snapshots. Copy into lib/constructs/. * Add post-deploy health check template Template script for project-specific health checks. Copy to scripts/health-check.sh — CD workflows run it automatically. |
||
|---|---|---|
| constructs | ||
| hooks | ||
| scripts | ||
| 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
- Git Hooks -- recommended pre-push and pre-commit hooks
- Scripts -- repo provisioning, automation tooling
- CDK Constructs -- shared VPN EC2 instance construct and other reusable patterns
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.