Back to standards

Version-Control Standard

A compact operating standard for presenting public work clearly while keeping private repositories, credentials, local files, and client-specific implementation details protected.

What gets checked before publishing

The goal is not to hide the work. The goal is to make the right work inspectable: claims, decisions, scope, and outcomes.

01

Commit Hygiene

Use short, descriptive commits and group related changes together.

02

Clean Repository Surface

Keep generated output, caches, dependency folders, and local environment files out.

03

Case-Study Boundary

Represent private work through scope, responsibilities, decisions, and results.

04

Credential Sweep

No secrets, tokens, unpublished datasets, or organization-specific internals.

Link what proves the work. Summarize what must stay private.

Portfolio evidence should be easy to inspect without exposing private code, credentials, or client-specific details.

Rule Proof public, source protected.
Public Review-ready

Safe to show

  • Public repositories and live website surfaces.
  • Case-study summaries with responsibilities and decisions.
  • README links, screenshots, architecture notes, and review context.
Protected Confidential

Keep out of public repos

  • Private source code, credentials, tokens, and `.env` files.
  • Unpublished datasets, local machine paths, and client-specific internals.
  • Large raw archives that make the portfolio hard to inspect.

Publishing checklist

A small repeatable review keeps the portfolio employer-safe and technically credible.

  1. git `git status --short` shows only intentional files.
  2. scan Credential, placeholder, and unfinished-work terms are searched before publishing.
  3. scope Private repositories are represented as case studies, not copied source.
  4. links README, case-study, website, and standards links resolve cleanly.
  5. load The built site serves `index.html`, `styles.css`, `script.js`, and project pages.