adam/engineering-handbook
1
0
Fork 0
mirror of https://github.com/Sea-Haven-Industries/engineering-handbook.git synced 2026-09-30 05:43:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
engineering-handbook/github-standards.md
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

951 B
Raw Blame History

GitHub Standards

Repository Defaults

  • Default branch: main
  • Every repo gets a one-line description
  • Default to private visibility for org repos
  • Dependabot alerts and security updates enabled on all active repos

Branch Protection

  • Require a PR for merges to main (no direct push)
  • No force push to main
  • No branch deletion for main

Repo Hygiene

  • Delete feature branches after merge
  • Archive repos that are no longer actively developed (close issues first)
  • Don't delete repos unless truly disposable
  • Scrub all company-specific info from git history before making any repo public

Public Repos

Before making a repo public, verify the entire git history contains no:

  • Phone numbers or customer data
  • API subdomains or internal URLs
  • Webhook endpoints
  • Employee names or internal identifiers

If sensitive data was committed at any point, start fresh with a clean git init rather than rewriting history.