Skip to content

amcheste/engineering-handbook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Alan's Engineering Handbook

How I build software — and the philosophies behind it.

Validate Version License: MIT OpenSSF Scorecard


This repo is my personal engineering handbook — the philosophies, workflows, and tooling that shape how I design, build, and ship software. It is written for myself first and shared publicly as a reference for anyone curious about how an engineer-first, AI-amplified practice actually works day to day.

It is a living document. Expect it to grow and change as my thinking evolves.

Contents

Philosophies

The why — principles that explain the decisions behind how I work. These change slowly.

  • Branching Strategy — why every repo runs on develop / main with CLI-merged releases and conventional commits.
  • Release Cadence & Semver Discipline — why releases are a deliberate ceremony, why the monthly patch cycle, and how conventional commits drive the version number.
  • Security Posture — why every repo ships with the same SAST, Scorecard, CODEOWNERS, and SLA baseline from day one.
  • Testing — why I write the tests I write, and why I don't write the ones I don't.

Workflows

The how — concrete steps, commands, and tooling that implement the philosophies. These change as tools evolve.

Development Tooling Stack

Design notes

Brainstorm-level design docs capturing how I'm thinking about specific engineering problems. Not polished specs — working documents that evolve as decisions get made.

More chapters are in progress.

How this repo works

  • develop is the default branch. All changes land via pull request.
  • main tracks released versions of the handbook.
  • The handbook is versioned with semver tags so I can reference a specific snapshot of my thinking over time.

License

MIT

About

My engineering handbook — principles, workflows, and tooling

Resources

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages