mirror of
https://github.com/Sea-Haven-Industries/engineering-handbook.git
synced 2026-09-30 13:53:14 +00:00
Engineering conventions and best practices for Sea Haven Industries
Adam Moussa
a4742fc97b
Capture the org conventions rolled out in the INFRA-47 hygiene pass: - github-standards.md: static-only README badges (dynamic shields break on private repos; CI badge is member-only) and a lowercase-hyphenated repo topic vocabulary, both part of new-repo provisioning. - cicd.md: the central inline-config reusable PR labeler — pull_request trigger, the three required caller permissions, no per-repo labeler.yml. |
||
|---|---|---|
| .github/workflows | ||
| constructs | ||
| hooks | ||
| scripts | ||
| aws-infrastructure.md | ||
| bedrock.md | ||
| cdk-project-layout.md | ||
| cicd.md | ||
| code-review-rubric.md | ||
| code-review.md | ||
| commit-messages.md | ||
| CONTRIBUTING.md | ||
| dev-environment.md | ||
| git-workflow.md | ||
| github-standards.md | ||
| lambda-template.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
- Development Environment -- workstation directory layout, pyenv, Node, launchd/TCC
- 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
- Code Review Rubric -- BLOCK/FIX/NIT/QUESTION finding categories and output format
- GitHub Standards -- branch defaults, repo hygiene, Dependabot
- AWS Infrastructure -- SAM vs CDK, Lambda defaults, CloudFormation
- SAM Project Layout -- standard directory structure for serverless projects
- CDK Project Layout -- standard directory structure for CDK projects
- Lambda Starter Template -- minimal SAM scaffold for a new Python Lambda
- Secrets and Configuration -- Secrets Manager vs SSM Parameter Store
- CI/CD Pipelines -- every deployable repo gets a pipeline, no manual deploys
- Bedrock -- cross-region inference profiles, alias pinning, KB Docker requirement
- 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.