chore: create PR template #1039
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughIntroduces a new GitHub pull request template at .github/pull_request_template.md with sections for Description, Tested, and How to QA. No source code or runtime behavior changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Comment on lines
+1
to
+11
| ### Description | ||
|
|
||
| _A brief description of the changes, what and how is being changed._ | ||
|
|
||
| ### Tested | ||
|
|
||
| _Explain how the change has been tested (for example by manual testing, unit tests etc) or why it's not necessary (for example version bump)._ | ||
|
|
||
| ### How to QA | ||
|
|
||
| _How can the change be tested in a repeatable manner?_ |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Augment template with security, contracts, performance, and rollout sections (critical for RN + TS + smart-contract app).
Missing prompts for security/privacy impact, smart contract changes, breaking changes/migrations, dependency risk, performance/bundle impact, and rollout/monitoring. These are medium-to-high priority for our stack and help prevent costly regressions and on-chain mistakes.
Apply this diff to extend the template:
### Description
_A brief description of the changes, what and how is being changed._
### Tested
_Explain how the change has been tested (for example by manual testing, unit tests etc) or why it's not necessary (for example version bump)._
### How to QA
_How can the change be tested in a repeatable manner?_
+
+### Security & Privacy Impact
+_Auth/permissions scope changes, secret handling, PII/data flows, encryption/storage, attack surface, and security testing performed (e.g., unit, fuzz, SAST)._
+
+### Smart Contract Impact
+_Networks, contract names/addresses, ABI changes, migrations/scripts, upgradability/governance approvals, and links (Etherscan/Blockscout). Risk assessment and roll-forward/back plan._
+
+### Breaking Changes & Migrations
+_Backward compatibility, app/data migration steps (including on-chain/off-chain), and explicit rollback procedure._
+
+### Performance & Bundle Impact
+_Expected impact on startup time, memory/CPU, and JS/native bundle size. Provide before/after metrics where possible._
+
+### Dependencies
+_New/updated/removed deps with versions, rationale, license notes, and security review outcome (advisories)._
+
+### Rollout & Monitoring
+_Feature flags, staged rollout plan, analytics/telemetry events, dashboards/alerts to watch, and kill switch._
+
+### Checklist
+- [ ] No secrets/keys committed; configs per env validated
+- [ ] Tests added/updated and passing (unit/integration/e2e)
+- [ ] iOS and Android builds verified locally/CI
+- [ ] Contract addresses/configs updated for all networks
+- [ ] Release notes/docs updated📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ### Description | |
| _A brief description of the changes, what and how is being changed._ | |
| ### Tested | |
| _Explain how the change has been tested (for example by manual testing, unit tests etc) or why it's not necessary (for example version bump)._ | |
| ### How to QA | |
| _How can the change be tested in a repeatable manner?_ | |
| ### Description | |
| _A brief description of the changes, what and how is being changed._ | |
| ### Tested | |
| _Explain how the change has been tested (for example by manual testing, unit tests etc) or why it's not necessary (for example version bump)._ | |
| ### How to QA | |
| _How can the change be tested in a repeatable manner?_ | |
| ### Security & Privacy Impact | |
| _Auth/permissions scope changes, secret handling, PII/data flows, encryption/storage, attack surface, and security testing performed (e.g., unit, fuzz, SAST)._ | |
| ### Smart Contract Impact | |
| _Networks, contract names/addresses, ABI changes, migrations/scripts, upgradability/governance approvals, and links (Etherscan/Blockscout). Risk assessment and roll-forward/back plan._ | |
| ### Breaking Changes & Migrations | |
| _Backward compatibility, app/data migration steps (including on-chain/off-chain), and explicit rollback procedure._ | |
| ### Performance & Bundle Impact | |
| _Expected impact on startup time, memory/CPU, and JS/native bundle size. Provide before/after metrics where possible._ | |
| ### Dependencies | |
| _New/updated/removed deps with versions, rationale, license notes, and security review outcome (advisories)._ | |
| ### Rollout & Monitoring | |
| _Feature flags, staged rollout plan, analytics/telemetry events, dashboards/alerts to watch, and kill switch._ | |
| ### Checklist | |
| - [ ] No secrets/keys committed; configs per env validated | |
| - [ ] Tests added/updated and passing (unit/integration/e2e) | |
| - [ ] iOS and Android builds verified locally/CI | |
| - [ ] Contract addresses/configs updated for all networks | |
| - [ ] Release notes/docs updated |
🤖 Prompt for AI Agents
In .github/pull_request_template.md around lines 1 to 11, the PR template is
missing required prompts for security/privacy impact, smart-contract/on-chain
changes, breaking changes/migrations, dependency risk, performance/bundle
impact, and rollout/monitoring; add new sections to the template titled
"Security & Privacy", "Smart Contract / On‑chain Changes", "Breaking Changes /
Migrations", "Dependencies & Risk", "Performance & Bundle Impact", and "Rollout
& Monitoring" (each with a short prompt to describe impact, mitigation steps,
and required reviewers or post-deploy checks), and update the "How to QA" or
"Tested" areas to reference any additional test steps for those sections so
submitters must explicitly document these aspects.
aaronmgdr
approved these changes
Sep 10, 2025
|
looks good to me |
|
one way to clear this issue to is push another commit to the branch 
|
transphorm
reviewed
Sep 11, 2025
| @@ -0,0 +1,11 @@ | |||
| ### Description | |||
There was a problem hiding this comment.
nit: can we also add space for a ticket? and a reminder that they can add the ticket number to the title?
ex: SELF-123: New feature
|
will need to merge this into dev first since main is blocked |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a simple PR template.
Tested
Not needed for this PR.
How to QA
The template should be picked up in subsequent PRs.
Summary by CodeRabbit