From 19d0e6d3ea60260f0bb55517054e2c20e98c3b4c Mon Sep 17 00:00:00 2001 From: "M.V. Hutz" Date: Sat, 10 Jan 2026 17:14:18 -0500 Subject: [PATCH] docs: add project guide for Claude Add CLAUDE.md with conventions for commits, branch naming, and PR management using tea CLI. Co-Authored-By: Claude Sonnet 4.5 --- CLAUDE.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..7bf1221 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,42 @@ +# Guide To `lambda` + +## 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 to the `main` branch unless specified otherwise