From d3d57b098bb2ce2b504db44665b10d4fb7e13cfa Mon Sep 17 00:00:00 2001 From: Poyraz Avsever Date: Sat, 18 Apr 2026 21:51:19 +0300 Subject: [PATCH] refactor: update issue and pull request templates for clarity and consistency --- .github/ISSUE_TEMPLATE/feature_request.md | 8 +++---- .github/PULL_REQUEST_TEMPLATE.md | 27 ++++++++++------------- SECURITY.md | 11 --------- 3 files changed, 15 insertions(+), 31 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index b883496..28d34ac 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -18,13 +18,11 @@ What do you want to happen? What alternatives did you evaluate? -## Acceptance criteria +## Success criteria (optional) -How will we know this is done? +How will we know this request is successful? -- [ ] User value: The proposed change solves the stated problem in an end-to-end user flow. -- [ ] Security and access control: Existing authorization rules are preserved, and no sensitive data is exposed. -- [ ] Verifiability: Completion is proven with test steps, reproducible evidence, or clear output/screenshots. +Describe 1-3 concrete outcomes. ## Non-goals (optional) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b7a7dd4..33cf586 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,10 @@ ## Summary -Explain what changed in this PR. + ## Why -Explain the problem this PR solves. - + ## Scope @@ -18,11 +17,17 @@ What areas are affected? - [ ] Documentation - [ ] Other -## Validation +## Before opening PR +- [ ] I have read [CONTRIBUTING.md](CONTRIBUTING.md) and followed repository conventions. - [ ] I ran `bun run check`. - [ ] I ran `bun run db:generate` if `prisma/schema.prisma` changed. - [ ] I manually tested affected flows. +- [ ] PR title follows Conventional Commits (`type(scope): summary`). +- [ ] I used `successResponse` / `apiErrors` for API response changes. +- [ ] I used `auth()` and shared access checks (`checkProjectAccess` / `checkWorkspaceAccess`) where relevant. +- [ ] I updated docs when behavior changed. +- [ ] No secrets or unrelated file changes are included. Validation notes: @@ -35,20 +40,12 @@ Paste command output or manual test notes here. - [ ] No breaking changes - [ ] This PR introduces a breaking change (describe below) -If breaking, explain migration path: + ## Database / migration notes -If schema changed, summarize migration impact. + ## Screenshots / examples (if relevant) -Add screenshots or API request/response examples. - -## Checklist - -- [ ] PR title follows Conventional Commits (`type(scope): summary`). -- [ ] I used `successResponse` / `apiErrors` for API response changes. -- [ ] I used `auth()` and shared access checks (`checkProjectAccess` / `checkWorkspaceAccess`) where relevant. -- [ ] I updated docs when behavior changed. -- [ ] No secrets or unrelated file changes are included. + diff --git a/SECURITY.md b/SECURITY.md index bef3f47..fc05a56 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -26,14 +26,3 @@ After a private report is submitted: 3. A fix is prepared and validated. 4. Disclosure timing is coordinated. 5. Credits are given when appropriate. - -## Scope Highlights - -Security-sensitive areas in this repository include: - -- Authentication and session handling in [lib/auth.ts](lib/auth.ts) -- Access control checks in [lib/route-access.ts](lib/route-access.ts) -- Share-link and guest access flows in [lib/share-links.ts](lib/share-links.ts) and [app/watch](app/watch) -- Upload validation and storage paths in [app/api/upload](app/api/upload) -- Billing and webhook handling in [app/api/billing](app/api/billing) and [app/api/stripe/webhook/route.ts](app/api/stripe/webhook/route.ts) -