|
| 1 | +name: "📦 Pull Request" |
| 2 | +description: "Submit a PR with structured details for review." |
| 3 | +title: "[PR] " |
| 4 | +labels: [] |
| 5 | +body: |
| 6 | + - type: markdown |
| 7 | + attributes: |
| 8 | + value: | |
| 9 | + # 📦 Pull Request |
| 10 | + Thanks for contributing! Please fill in all required fields to ensure smooth review. |
| 11 | +
|
| 12 | + - type: input |
| 13 | + id: summary |
| 14 | + attributes: |
| 15 | + label: Short summary (one line) |
| 16 | + description: "e.g., feat(auth): add SSO login" |
| 17 | + placeholder: "Short descriptive title" |
| 18 | + validations: |
| 19 | + required: true |
| 20 | + |
| 21 | + - type: textarea |
| 22 | + id: description |
| 23 | + attributes: |
| 24 | + label: Description |
| 25 | + description: "What does this PR do? Why is it needed?" |
| 26 | + placeholder: "Provide context for the change..." |
| 27 | + validations: |
| 28 | + required: true |
| 29 | + |
| 30 | + - type: dropdown |
| 31 | + id: type_of_change |
| 32 | + attributes: |
| 33 | + label: Type of change |
| 34 | + options: |
| 35 | + - Bug fix |
| 36 | + - New feature |
| 37 | + - Breaking change |
| 38 | + - Chore / refactor / documentation |
| 39 | + validations: |
| 40 | + required: true |
| 41 | + |
| 42 | + - type: textarea |
| 43 | + id: related_issues |
| 44 | + attributes: |
| 45 | + label: Related tickets / issues |
| 46 | + description: "List related issue numbers, e.g., Closes #123" |
| 47 | + placeholder: "Closes #123" |
| 48 | + validations: |
| 49 | + required: false |
| 50 | + |
| 51 | + - type: textarea |
| 52 | + id: changes |
| 53 | + attributes: |
| 54 | + label: Proposed changes |
| 55 | + description: "List key changes included in this PR." |
| 56 | + placeholder: | |
| 57 | + - Added ... |
| 58 | + - Updated ... |
| 59 | + - Removed ... |
| 60 | + validations: |
| 61 | + required: true |
| 62 | + |
| 63 | + - type: textarea |
| 64 | + id: test_instructions |
| 65 | + attributes: |
| 66 | + label: How to test / QA |
| 67 | + description: "Provide clear steps for reviewers/testers." |
| 68 | + placeholder: | |
| 69 | + 1. Checkout branch... |
| 70 | + 2. Run tests... |
| 71 | + 3. Verify behavior... |
| 72 | + validations: |
| 73 | + required: true |
| 74 | + |
| 75 | + - type: checkboxes |
| 76 | + id: checklist |
| 77 | + attributes: |
| 78 | + label: Checklist (required) |
| 79 | + description: Ensure your PR meets these requirements. |
| 80 | + options: |
| 81 | + - label: Tests added/updated and passing locally |
| 82 | + - label: Documentation updated (if applicable) |
| 83 | + - label: Linting and formatting completed |
| 84 | + - label: PR title follows repo conventions (e.g., conventional commits) |
| 85 | + - label: No sensitive data or secrets are included |
| 86 | + validations: |
| 87 | + required: true |
| 88 | + |
| 89 | + - type: textarea |
| 90 | + id: rollout |
| 91 | + attributes: |
| 92 | + label: Rollout plan & backwards compatibility |
| 93 | + description: "List deployment steps, flags, compatibility notes." |
| 94 | + placeholder: "This change is backward compatible because..." |
| 95 | + validations: |
| 96 | + required: false |
| 97 | + |
| 98 | + - type: textarea |
| 99 | + id: migrations |
| 100 | + attributes: |
| 101 | + label: Database migrations (if any) |
| 102 | + description: "Describe any migrations and whether they are safe/additive." |
| 103 | + placeholder: | |
| 104 | + - Migration script: /sql/migrations/xxx.sql |
| 105 | + - Up: ... |
| 106 | + - Down: ... |
| 107 | + validations: |
| 108 | + required: false |
| 109 | + |
| 110 | + - type: textarea |
| 111 | + id: security |
| 112 | + attributes: |
| 113 | + label: Security considerations |
| 114 | + description: "Does this PR affect auth, secrets, PII, or permissions?" |
| 115 | + placeholder: | |
| 116 | + - No sensitive data |
| 117 | + - Touches auth: added validation... |
| 118 | + validations: |
| 119 | + required: false |
| 120 | + |
| 121 | + - type: textarea |
| 122 | + id: performance |
| 123 | + attributes: |
| 124 | + label: Performance considerations |
| 125 | + description: "Any impact on speed, memory, or scaling?" |
| 126 | + placeholder: "No measurable performance impact." |
| 127 | + validations: |
| 128 | + required: false |
| 129 | + |
| 130 | + - type: textarea |
| 131 | + id: screenshots |
| 132 | + attributes: |
| 133 | + label: Screenshots / recordings |
| 134 | + description: "If UI changed, include visuals." |
| 135 | + placeholder: "Attach before/after screenshots..." |
| 136 | + validations: |
| 137 | + required: false |
| 138 | + |
| 139 | + - type: input |
| 140 | + id: changelog |
| 141 | + attributes: |
| 142 | + label: Changelog entry |
| 143 | + description: "Short entry for release notes." |
| 144 | + placeholder: "Added support for X in API Y" |
| 145 | + validations: |
| 146 | + required: false |
| 147 | + |
| 148 | + - type: input |
| 149 | + id: reviewers |
| 150 | + attributes: |
| 151 | + label: Suggested reviewers |
| 152 | + description: "Tag team members or @teams as needed." |
| 153 | + placeholder: "@your-team" |
| 154 | + validations: |
| 155 | + required: false |
0 commit comments