mirror of
https://github.com/Sea-Haven-Industries/engineering-handbook.git
synced 2026-09-30 10:23:13 +00:00
896bfc7501
Some checks are pending
ci / ci / ci (push) Waiting to run
docs: align engineering conventions for Cursor migration (PLAT-62)
37 lines
2.4 KiB
Markdown
37 lines
2.4 KiB
Markdown
# Engineering Handbook
|
|
|
|
|
|
|
|
|
|
|
|
Engineering conventions and best practices for Sea Haven Industries.
|
|
|
|
## Contents
|
|
|
|
- [Naming Conventions](naming-conventions.md) -- kebab-case everywhere, no exceptions
|
|
- [Development Environment](dev-environment.md) -- workstation directory layout, pyenv, Node, launchd/TCC
|
|
- [Issue Tracking](issue-tracking.md) -- Jira projects, ticket description template, ticket hygiene
|
|
- [Git Workflow](git-workflow.md) -- feature branches, incremental commits, CI-on-merge
|
|
- [Commit Messages](commit-messages.md) -- Conventional Commits, type(scope) format, 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
|
|
- [Code Review Rubric](code-review-rubric.md) -- BLOCK/FIX/NIT/QUESTION finding categories and output format
|
|
- [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
|
|
- [CDK Project Layout](cdk-project-layout.md) -- standard directory structure for CDK projects
|
|
- [Lambda Starter Template](lambda-template.md) -- minimal SAM scaffold for a new Python Lambda
|
|
- [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
|
|
- [Bedrock](bedrock.md) -- cross-region inference profiles, alias pinning, KB Docker requirement
|
|
- [Git Hooks](hooks/) -- shim for the global security pre-push hook
|
|
- [Scripts](scripts/) -- repo provisioning, automation tooling
|
|
- [CDK Constructs](constructs/) -- shared VPN EC2 instance construct and other reusable patterns
|
|
|
|
## 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.
|