From 7a5944594f6a2d62dc7f5645c1839425561328f9 Mon Sep 17 00:00:00 2001 From: "M.V. Hutz" Date: Sat, 10 Jan 2026 22:32:15 +0000 Subject: [PATCH] docs: add project guidelines for Claude Code (#4) ## Summary - Add CLAUDE.md with project guidelines - Documents conventional commit format and types - Specifies branch naming conventions - Includes PR management instructions using tea CLI ## Test plan - Review CLAUDE.md content - Verify formatting and accuracy Reviewed-on: https://git.maximhutz.com/mvhutz/lambda/pulls/4 Co-authored-by: M.V. Hutz Co-committed-by: M.V. Hutz --- CLAUDE.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..a518c28 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,44 @@ +# Guide To `lambda` + +Absolutely NO advertisement of Claude. + +## Coding Styles + +### Conventional Commits + +Use conventional commit format: `: `. + +**Types**: `feat`, `fix`, `docs`, `refactor`, `test`, `chore`, `perf` + +**Examples**: + +- `feat: add explanation mode flag to CLI` +- `fix: correct variable renaming in nested abstractions` +- `docs: update Makefile documentation` + +### Branch Names + +Use format: `/` with kebab-case. + +**Types**: Same as commits: `feat`, `fix`, `docs`, `refactor`, `test`, `chore`, `perf`. + +**Examples**: + +- `feat/explanation-mode` +- `fix/variable-renaming` +- `docs/makefile-improvements` +- `refactor/silent-directive` + +## Pull Request Management + +Use the `tea` CLI (Gitea command-line tool) for PR operations instead of `gh`. + +**Common commands**: + +- `tea pr create` - Create a new pull request. +- `tea pr list` - List pull requests. +- `tea pr checkout ` - Check out a PR locally. +- `tea pr close ` - Close a pull request. +- `tea pr merge ` - Merge a pull request. + +**Creating PRs**: Always create PRs in a branch other than `main`, to the `main` branch unless specified otherwise.