mirror of
https://github.com/yusufipk/OpenFrame.git
synced 2026-09-11 09:36:08 +00:00
refactor: update issue and pull request templates for clarity and consistency
This commit is contained in:
@@ -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)
|
||||
|
||||
|
||||
@@ -1,11 +1,10 @@
|
||||
## Summary
|
||||
|
||||
Explain what changed in this PR.
|
||||
<!-- Explain what changed in this PR. -->
|
||||
|
||||
## Why
|
||||
|
||||
Explain the problem this PR solves.
|
||||
|
||||
<!-- 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:
|
||||
<!-- If breaking, explain migration path. -->
|
||||
|
||||
## Database / migration notes
|
||||
|
||||
If schema changed, summarize migration impact.
|
||||
<!-- 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.
|
||||
<!-- Add screenshots or API request/response examples. -->
|
||||
|
||||
Reference in New Issue
Block a user