M.V. Hutz
8b6c632e4d
## Description Added a standardized pull request template to improve PR quality and consistency. The template provides a clear structure for contributors to follow when creating PRs. The template includes: - Title placeholder following conventional commit format (`<type>: <description>`) - Description section with guidance on context, rationale, and changes - Optional Decisions section for architectural choices - Benefits section to highlight improvements - Checklist for conventional commits, branch naming, tests, and documentation ### Decisions Created the template in `.gitea/PULL_REQUEST_TEMPLATE/default.md` to support multiple template types in the future. ## Benefits - Ensures PRs follow project conventions (conventional commits, branch naming) - Provides clear structure for describing changes - Helps reviewers understand context and benefits - Reduces back-and-forth by reminding contributors of requirements - Supports future expansion with additional template types Reviewed-on: #5 Co-authored-by: M.V. Hutz <git@maximhutz.me> Co-committed-by: M.V. Hutz <git@maximhutz.me>
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.
|