mirror of
https://github.com/Sea-Haven-Industries/engineering-handbook.git
synced 2026-09-30 04:33:13 +00:00
0333e7f8f5
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).
39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
# Naming Conventions
|
|
|
|
## The Rule
|
|
|
|
kebab-case for everything. No exceptions.
|
|
|
|
No `snake_case`, `PascalCase`, or mixed styles anywhere.
|
|
|
|
## Where It Applies
|
|
|
|
| Resource | Example |
|
|
|---|---|
|
|
| Repository names | `expense-approval-bot`, `door-unlock-api` |
|
|
| CloudFormation stack names | `expense-approval-bot` (must match repo name) |
|
|
| Lambda function names | `expense-approval-bot-process-receipt` |
|
|
| DynamoDB table names | `expense-approval-bot-receipts` |
|
|
| S3 bucket names | `expense-approval-bot-uploads` |
|
|
| Secrets Manager secrets | `expense-approval-bot/slack-signing` |
|
|
| Feature branches | `feature/add-receipt-parser` |
|
|
|
|
## CDK Gotcha
|
|
|
|
CDK generates PascalCase stack names by default. Always set an explicit `stackName` (TypeScript) or `stack_name` (Python) in your stack definition to enforce kebab-case.
|
|
|
|
```typescript
|
|
new MyStack(app, 'MyStack', {
|
|
stackName: 'my-stack',
|
|
});
|
|
```
|
|
|
|
## Examples
|
|
|
|
| Bad | Good | Why |
|
|
|---|---|---|
|
|
| `ExpenseApprovalBot` | `expense-approval-bot` | PascalCase |
|
|
| `expense_approval_bot` | `expense-approval-bot` | snake_case |
|
|
| `expenseApprovalBot` | `expense-approval-bot` | camelCase |
|
|
| `Expense-Approval-Bot` | `expense-approval-bot` | Mixed case |
|
|
| `feature/AddParser` | `feature/add-parser` | PascalCase in branch |
|