Skip to content

Repository files navigation

Dev Conventions & Guidelines

Development conventions for all projects. A project copies a few small files (see below) and inherits the rest by reference.

Files

File What it covers
branching.md Unit of work, branches, merge requests, review, hygiene
commits.md Conventional + atomic commits, gitlint
php.md PHP app & library shapes, tooling, CI gates
python.md uv/pyproject stack, layout, ruff/pytest
go.md Module naming, layout, golangci-lint, tests
typescript.md pnpm monorepo contract, env templates, vitest
mcp.md Client/service split, prompt placement, tools, publishing
mobile-app.md Flutter app/library layout, spikes, tests, releases
agent-tooling.md AGENTS.md policy, what to track vs ignore
stack.md DB & infrastructure preferences
templates/ Files each project copies in

Applying to a repo (new or existing)

  1. Copy templates/AGENTS.md to the repo root, fill the {{...}} placeholders, delete sections that don't apply. Keep it one page.
  2. Copy templates/CLAUDE.md (and equivalents for other tools as needed), templates/.gitignore, templates/.gitlint, and templates/gitlint_rules.py verbatim; extend .gitignore only with project-specific runtime output.
  3. Add the commit-lint job (templates/commit-lint.yml) to the repo's CI config.
  4. Done. Everything else in this repo is reference material that humans and agents consult via the link in AGENTS.md.

Maintainer instructions for this repo: AGENTS.md.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages