From c6f36575b7bcba86130858060da3057d9912baa9 Mon Sep 17 00:00:00 2001 From: Anso Date: Tue, 18 Aug 2026 21:58:03 -0400 Subject: [PATCH] docs: expand pull request template for public contributors (#1837) --- .github/PULL_REQUEST_TEMPLATE.md | 44 +++++++++++++++++++++++++------- CONTRIBUTING.md | 3 +++ 2 files changed, 38 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8b4782ef..5dac3b4c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,41 @@ -## What does this PR do? + +Keep this PR to one concern. Do not include secrets, tokens, credentials, +private keys, or real hostnames/IPs in the diff, commits, or this description. +Report security issues privately (see https://github.com/studio-saelix/sencho/blob/main/SECURITY.md), +not in a public pull request. +--> -## Related Issue +## Summary - + + +## Type of change + +- [ ] Bug fix +- [ ] New feature +- [ ] Documentation +- [ ] Tests +- [ ] Refactor, chore, or CI +- [ ] Breaking change + +## Related issue + + + +## Testing performed + + ## Checklist -- [ ] Tests added/updated (if applicable) -- [ ] Documentation updated (if applicable) -- [ ] ESLint passes (`npm run lint` in backend/ and frontend/) -- [ ] Commit messages follow Conventional Commits -- [ ] Commit message follows Conventional Commits (the CHANGELOG entry is generated from the commit subject by release-please; do not edit `CHANGELOG.md` directly). +- [ ] CLA check must pass ([CLA.md](https://github.com/studio-saelix/sencho/blob/main/CLA.md); you will be prompted on your first PR) +- [ ] Tests added or updated, or this change does not need them +- [ ] Docs updated if user-facing behavior, labels, or defaults changed +- [ ] Lint and typecheck pass locally (`npm run lint` and `npx tsc --noEmit` in `backend/` and/or `frontend/` as applicable) +- [ ] Commit messages and the PR title follow [Conventional Commits](https://www.conventionalcommits.org/) (the CHANGELOG line comes from the subject; do not edit `CHANGELOG.md`) +- [ ] This PR stays on one concern and contains no secrets diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1069480..0b026351 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,11 +62,14 @@ Sencho and Studio Saelix names and logos are trademarks. AGPLv3 does not grant t ## Pull Request Process - All PRs target `main` +- Fill in the pull request template (summary, type of change, testing performed). +- The CLA Assistant check must pass. First-time contributors are prompted to sign [CLA.md](CLA.md). - Ensure CI passes before requesting review - Use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages - Update documentation if your change affects user-facing behavior - Add tests for new functionality - Keep PRs focused: one feature or fix per PR +- Do not include secrets, tokens, credentials, or real hostnames/IPs in the diff, commits, or PR description. - Do not edit `CHANGELOG.md` directly. It is generated from conventional-commit subjects by release-please. If a user-facing change needs more context, enrich the auto-opened Release PR description before merging. ## Reporting Bugs