Update PULL_REQUEST_TEMPLATE.md#983
Conversation
WalkthroughThis pull request adds a new "Schema Changes" section to the GitHub pull request template file. The section includes a checkbox item requiring contributors to confirm that breaking database schema changes have been communicated in the superset channel on Slack. The modification consists of 4 new lines added to the template with no removals. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 36: Update the checklist item text that currently reads "[ ] Breaking
database schema changes have been communicated in the superset channel on slack"
to use the correct product capitalization: change "slack" to "Slack" so the line
reads "[ ] Breaking database schema changes have been communicated in the
superset channel on Slack".
🧹 Nitpick comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
34-37: Consider clarifying the scope and channel reference.A few suggestions to improve clarity:
Scope: The checkbox currently only mentions "breaking" schema changes. Consider whether all database schema changes (breaking or non-breaking) should be communicated to the delivery team, as even non-breaking changes might affect reporting, analytics, or downstream systems.
Channel format: Consider using the
#supersetformat (with hash prefix) to make it clearer that this refers to a Slack channel name.💡 Alternative wording options
Option 1 (broader scope):
### Schema Changes -- [ ] Breaking database schema changes have been communicated in the superset channel on Slack +- [ ] Database schema changes have been communicated in the `#superset` channel on SlackOption 2 (keep breaking-only but clarify format):
### Schema Changes -- [ ] Breaking database schema changes have been communicated in the superset channel on Slack +- [ ] Breaking database schema changes have been communicated in the `#superset` channel on Slack
|
|
||
| ### Schema Changes | ||
|
|
||
| - [ ] Breaking database schema changes have been communicated in the superset channel on slack |
There was a problem hiding this comment.
Capitalize "Slack" as it's a product name.
"slack" should be capitalized to "Slack" as it refers to the product/platform name.
📝 Proposed fix
-- [ ] Breaking database schema changes have been communicated in the superset channel on slack
+- [ ] Breaking database schema changes have been communicated in the superset channel on Slack📝 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.
| - [ ] Breaking database schema changes have been communicated in the superset channel on slack | |
| - [ ] Breaking database schema changes have been communicated in the superset channel on Slack |
🤖 Prompt for AI Agents
In @.github/PULL_REQUEST_TEMPLATE.md at line 36, Update the checklist item text
that currently reads "[ ] Breaking database schema changes have been
communicated in the superset channel on slack" to use the correct product
capitalization: change "slack" to "Slack" so the line reads "[ ] Breaking
database schema changes have been communicated in the superset channel on
Slack".
| - Link to QA Ticket | ||
| --> | ||
|
|
||
| ### Schema Changes |
There was a problem hiding this comment.
I know I approved, but can we add a comment here explaining what "breaking changes" entails in the context of superset?
E.g.
<!--
- Any field renames
- Any field removals
- etc.
-->
There was a problem hiding this comment.
nit: Also, do we want to remove this section if there are no breaking changes? Similar to how on HQ we remove the section for migration reversal.
I am also okay with the current way this has been done. May be we can rephrase to say
"If there are breaking changes..."
the only confusing bit about that is that when someone reads they can't tell if there actually were breaking changes without reading the code changes.
There was a problem hiding this comment.
nit: Also, do we want to remove this section if there are no breaking changes? Similar to how on HQ we remove the section for migration reversal.
Can you say more? Is this a change we would make to the template in this PR, or just how you would use it?
There was a problem hiding this comment.
Referring to this part in HQ template for PRs
This is simply to differentiate between
- there are no breaking changes
- breaking changes are present and have been communicated
zandre-eng
left a comment
There was a problem hiding this comment.
+1 on Charl's suggestion for adding a comment.
Technical Summary
Just updating the PR template to add a new field based on recent conversations about notifying delivery for database schema changes