feat: add pull request template #5

Merged
mvhutz merged 2 commits from feat/pr-templates into main 2026-01-10 22:44:42 +00:00
2 changed files with 45 additions and 3 deletions

View File

@@ -0,0 +1,32 @@
---
title: "<type>: <description>"
---
## Description
<!--
First, describe the context for the PR.
Then, explain why the PR exists.
Finally, in concise, sentence-long bullets, explain each change.
-->
### Decisions
<!--
List any major architectural decisions here.
If none exist, omit this section.
-->
## Benefits
<!--
List any major benefits here.
How would this PR improve the codebase/product?
-->
## Checklist
- [ ] Code follows conventional commit format.
- [ ] Branch follows naming convention (`<type>/<description>`).
- [ ] Tests pass (if applicable).
- [ ] Documentation updated (if applicable).

View File

@@ -1,8 +1,12 @@
# Guide To `lambda` # Guide To `lambda`
Absolutely NO advertisement of Claude. ## Documentation Style
## Coding Styles Use full sentences.
Every sentence gets its own line in Markdown.
Every sentence ends in a period.
## Coding Style
### Conventional Commits ### Conventional Commits
@@ -16,6 +20,8 @@ Use conventional commit format: `<type>: <description>`.
- `fix: correct variable renaming in nested abstractions` - `fix: correct variable renaming in nested abstractions`
- `docs: update Makefile documentation` - `docs: update Makefile documentation`
DO NOT advertise Claude.
### Branch Names ### Branch Names
Use format: `<type>/<description>` with kebab-case. Use format: `<type>/<description>` with kebab-case.
@@ -29,16 +35,20 @@ Use format: `<type>/<description>` with kebab-case.
- `docs/makefile-improvements` - `docs/makefile-improvements`
- `refactor/silent-directive` - `refactor/silent-directive`
DO NOT advertise Claude.
## Pull Request Management ## Pull Request Management
Use the `tea` CLI (Gitea command-line tool) for PR operations instead of `gh`. Use the `tea` CLI (Gitea command-line tool) for PR operations instead of `gh`.
**Common commands**: **Common commands**:
- `tea pr create` - Create a new pull request. - `tea pr create --title "<title>" --description "<body>"` - Create a new pull request.
- `tea pr list` - List pull requests. - `tea pr list` - List pull requests.
- `tea pr checkout <number>` - Check out a PR locally. - `tea pr checkout <number>` - Check out a PR locally.
- `tea pr close <number>` - Close a pull request. - `tea pr close <number>` - Close a pull request.
- `tea pr merge <number>` - Merge 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. **Creating PRs**: Always create PRs in a branch other than `main`, to the `main` branch unless specified otherwise.