M.V. Hutz
bfe5bacff4
Added --title and --description flags to tea pr create command documentation to clarify correct syntax and prevent errors. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
55 lines
1.4 KiB
Markdown
55 lines
1.4 KiB
Markdown
# Guide To `lambda`
|
|
|
|
## Documentation Style
|
|
|
|
Use full sentences.
|
|
Every sentence gets its own line in Markdown.
|
|
Every sentence ends in a period.
|
|
|
|
## Coding Style
|
|
|
|
### Conventional Commits
|
|
|
|
Use conventional commit format: `<type>: <description>`.
|
|
|
|
**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`
|
|
|
|
DO NOT advertise Claude.
|
|
|
|
### Branch Names
|
|
|
|
Use format: `<type>/<description>` 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`
|
|
|
|
DO NOT advertise Claude.
|
|
|
|
## Pull Request Management
|
|
|
|
Use the `tea` CLI (Gitea command-line tool) for PR operations instead of `gh`.
|
|
|
|
**Common commands**:
|
|
|
|
- `tea pr create --title "<title>" --description "<body>"` - Create a new pull request.
|
|
- `tea pr list` - List pull requests.
|
|
- `tea pr checkout <number>` - Check out a PR locally.
|
|
- `tea pr close <number>` - Close a pull request.
|
|
- `tea pr merge <number>` - Merge a pull request.
|
|
|
|
**Note**: Use `--description` (not `--body`) for PR body content.
|
|
|
|
**Creating PRs**: Always create PRs in a branch other than `main`, to the `main` branch unless specified otherwise.
|