From 8b6c632e4d8abc48e0287245085774f15a49562d Mon Sep 17 00:00:00 2001 From: "M.V. Hutz" Date: Sat, 10 Jan 2026 22:44:41 +0000 Subject: [PATCH] feat: add pull request template (#5) ## 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 (`: `) - 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: https://git.maximhutz.com/mvhutz/lambda/pulls/5 Co-authored-by: M.V. Hutz Co-committed-by: M.V. Hutz --- .gitea/PULL_REQUEST_TEMPLATE/default.md | 32 +++++++++++++++++++++++++ CLAUDE.md | 16 ++++++++++--- 2 files changed, 45 insertions(+), 3 deletions(-) create mode 100644 .gitea/PULL_REQUEST_TEMPLATE/default.md diff --git a/.gitea/PULL_REQUEST_TEMPLATE/default.md b/.gitea/PULL_REQUEST_TEMPLATE/default.md new file mode 100644 index 0000000..faa93b5 --- /dev/null +++ b/.gitea/PULL_REQUEST_TEMPLATE/default.md @@ -0,0 +1,32 @@ +--- +title: ": " +--- + +## Description + + + +### Decisions + + + +## Benefits + + + +## Checklist + +- [ ] Code follows conventional commit format. +- [ ] Branch follows naming convention (`/`). +- [ ] Tests pass (if applicable). +- [ ] Documentation updated (if applicable). diff --git a/CLAUDE.md b/CLAUDE.md index a518c28..d57c51e 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,8 +1,12 @@ # 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 @@ -16,6 +20,8 @@ Use conventional commit format: `: `. - `fix: correct variable renaming in nested abstractions` - `docs: update Makefile documentation` +DO NOT advertise Claude. + ### Branch Names Use format: `/` with kebab-case. @@ -29,16 +35,20 @@ Use format: `/` with kebab-case. - `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` - Create a new pull request. +- `tea pr create --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.