adam/engineering-handbook

Fork 0

mirror of https://github.com/Sea-Haven-Industries/engineering-handbook.git synced 2026-09-30 10:23:13 +00:00

Commit graph

Author	SHA1	Message	Date
Adam Moussa	855b473479	docs: adopt conventional commit format as the org standard Make Conventional Commits (type(scope): description) the canonical commit and PR-title format across Sea Haven, replacing the previous imperative/capitalized/no-prefix rule. - commit-messages.md: full rewrite to the type(scope): description format with the type table, lowercase/imperative description rules, breaking-change (! + BREAKING CHANGE footer) guidance tied to SemVer, and updated template and examples. - git-workflow.md: extend the branch-prefix table with chore/, docs/, refactor/, and release/ (alongside the existing feature/bug/hotfix), mirroring the commit types. - pull-requests.md: reconcile the title rule to the Conventional Commit format. - README.md: update the commit-messages one-line summary. Refs: INFRA-57	2026-07-17 19:30:02 -04:00
Adam Moussa	40553157c2	Update PR description template to match team format (#4 ) Replace Changes/Test Plan sections with Validation/Tests/Notes to align with the standardized PR format used across all repos.	2026-05-08 13:56:21 -04:00
Adam Moussa	0333e7f8f5	Add engineering handbook 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).	2026-05-02 16:42:44 -04:00

Author

SHA1

Message

Date

Adam Moussa

855b473479

docs: adopt conventional commit format as the org standard

Make Conventional Commits (type(scope): description) the canonical
commit and PR-title format across Sea Haven, replacing the previous
imperative/capitalized/no-prefix rule.

- commit-messages.md: full rewrite to the type(scope): description
  format with the type table, lowercase/imperative description rules,
  breaking-change (! + BREAKING CHANGE footer) guidance tied to SemVer,
  and updated template and examples.
- git-workflow.md: extend the branch-prefix table with chore/, docs/,
  refactor/, and release/ (alongside the existing feature/bug/hotfix),
  mirroring the commit types.
- pull-requests.md: reconcile the title rule to the Conventional Commit
  format.
- README.md: update the commit-messages one-line summary.

Refs: INFRA-57

2026-07-17 19:30:02 -04:00

Adam Moussa

40553157c2

Update PR description template to match team format (#4 )

Replace Changes/Test Plan sections with Validation/Tests/Notes
to align with the standardized PR format used across all repos.

2026-05-08 13:56:21 -04:00

Adam Moussa

0333e7f8f5

Add engineering handbook

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).

2026-05-02 16:42:44 -04:00

3 commits