mvhutz/lambda
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add pull request template (#5)

Browse Source 
## 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>
This commit was merged in pull request #5.
This commit is contained in:
Maxim Hutz
2026-01-10 22:44:41 +00:00
committed by Maxim Hutz
parent 7a5944594f
commit 8b6c632e4d
2 changed files with 45 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
.gitea/PULL_REQUEST_TEMPLATE/default.md Normal file
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).

16
CLAUDE.md
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.