M.V. Hutz
19652563a4
## Description This PR updates CLAUDE.md to include documentation about linking issues in pull requests. The documentation explains how to use the "Closes #<number>" syntax in commit messages and PR descriptions to automatically link and close issues when PRs are merged. ### Changes - Added "Linking issues" section to Pull Request Management in [CLAUDE.md](CLAUDE.md:81-82). - Documented the use of `Closes #<number>` syntax for automatic issue closure. ## Benefits Developers will know to properly link issues in their PRs. Issues will be automatically closed when their corresponding PRs are merged. The repository will maintain better traceability between issues and PRs. ## Checklist - [x] Code follows conventional commit format. - [x] Branch follows naming convention (`<type>/<description>`). Always use underscores. - [x] Tests pass (if applicable). - [x] Documentation updated (if applicable). Reviewed-on: #23 Co-authored-by: M.V. Hutz <git@maximhutz.me> Co-committed-by: M.V. Hutz <git@maximhutz.me>
83 lines
2.5 KiB
Markdown
83 lines
2.5 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.
|
|
|
|
## Issue Management
|
|
|
|
Use the `tea` CLI (Gitea command-line tool) for issue operations.
|
|
|
|
**Common commands**:
|
|
|
|
- `tea issues list` - List all issues.
|
|
- `tea issues <number>` - View details of a specific issue.
|
|
- `tea issues create --title "<title>" --body "<description>"` - Create a new issue.
|
|
- `tea issues close <number>` - Close an issue.
|
|
|
|
**Reading issues**: Use `tea issues <number>` to read the full details of an issue before starting work.
|
|
|
|
## Issue Workflow
|
|
|
|
When working on an issue:
|
|
|
|
1. Read the issue using `tea issues <number>` to understand requirements.
|
|
2. Create a feature branch following the branch naming convention.
|
|
3. Make commits following the conventional commit format.
|
|
4. Submit a pull request when ready.
|
|
|
|
**Important**: Never commit directly to `main`.
|
|
All work must be done in a feature branch and submitted via pull request.
|
|
|
|
## 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. ALWAYS FOLLOW THE PR TEMPLATE, EXACTLY.
|
|
|
|
**Linking issues**: When a PR solves an issue, reference the issue in both the commit message and PR description using `Closes #<number>`.
|
|
This automatically links and closes the issue when the PR is merged.
|