Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR Template Updates #22

Merged
merged 3 commits into from
Apr 4, 2024
Merged

Conversation

danielwheeler1987
Copy link
Contributor

@danielwheeler1987 danielwheeler1987 commented Apr 3, 2024

Stakeholder Overview (learn more)

This PR updates a few things:

  1. It updates the CODEOWNERS file to designate Tailor Made & Premium Blend teams as owners of the PR template. This is to aid with team-wide communication / change management, especially after significant improvements like adding the Risk Assessment section last year.
  2. It introduces a new Data & Analytics Dependencies section to the PR template, to address issues identified during Accounts Verification conversions.
  3. Changes some of the risks in the risk assessment to use the warning (⚠️) emoji instead of the green check (✅), for a clearer at-a-glance assessment of a PR's risks. See below as an example for this PR.

Risk Estimate (learn more)

No Risk! This is just a PR Template & CODEOWNERS update.

  • ⚠️ Not hidden by feature flag
  • ✅ Negligible risk!

What GIF Best Describes This Pull Request?

@danielwheeler1987 danielwheeler1987 requested a review from a team as a code owner April 3, 2024 14:49
@danielwheeler1987 danielwheeler1987 changed the title Dwheeler/update pr template PR Template Updates Apr 3, 2024
.github/CODEOWNERS Outdated Show resolved Hide resolved
Copy link
Member

@chmurph2 chmurph2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I take this opportunity to change this:

  • ✅ Big/complex change
  • ✅ Big splash zone
  • ✅ High stakes if errors occur
  • ✅ Low confidence
  • ✅ Not hidden by feature flag
  • ✅ Negligible risk!

to be this?

  • ⚠️ Big/complex change
  • ⚠️ Big splash zone
  • ⚠️ High stakes if errors occur
  • ⚠️ Low confidence
  • ⚠️ Not hidden by feature flag
  • ✅ Negligible risk!

I continue to find the ✅s for those bullets that amount to actual warnings to be misleading. I think that, at a glance, we should know this PR has some things to consider if there are any ⚠️s.

I'm happy to open a separate PR for this too.

@danielwheeler1987
Copy link
Contributor Author

@chmurph2 I'm fine with you making that change in this PR. We will want to provide insight to the teams this change is coming.

@chmurph2 chmurph2 force-pushed the dwheeler/update-pr-template branch from 384a447 to 9f27b78 Compare April 4, 2024 15:34
Copy link
Member

@chmurph2 chmurph2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that while the raw markdown syntax doesn't render the warning emoji, GitHub's rich text does render it as an emoji:

CleanShot 2024-04-04 at 11 28 34@2x

CleanShot 2024-04-04 at 11 28 16@2x


##### Data & Analytics Dependencies
- For customer-facing applications, are there any GA tagging changes that are needed or created by this change? If so, have those been discussed with D&A?
- Has Data Engineering been notified of any schema changes?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should mainly be for modifications of existing schema attributes. Additions shouldn't matter. I don't know the details of what was discussed previously around this though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Has Data Engineering been notified of any schema changes?" Should cover all the basis here.

Copy link
Contributor

@Shimmi Shimmi Apr 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Has Data Engineering been notified of any schema changes

Not sure this is the best wording or requirement. We do not do that unless it results in an impact on Datafuse configuration. Even if it does, we tend to prepare a PR to change that and run that true Data team.

@danielwheeler1987 danielwheeler1987 merged commit 172c5c3 into master Apr 4, 2024
@Shimmi
Copy link
Contributor

Shimmi commented Apr 4, 2024

It introduces a new Data & Analytics Dependencies section to the PR template, to address issues identified during Accounts Verification conversions.

For customer-facing applications, are there any GA tagging changes that are needed or created by this change? If so, have those been discussed with D&A?

I think, if this section had been there back then, we would still have answered "Yes, there are" and "Yes, we discussed it" to it...

Even tho this section may make people think about it for a second or two, I might put more focus on Why and What to do. Thinking out loud:

  • Is that sufficient if the engineer simply answers Yes and Yes? Maybe we'd like engineers to describe the GA changes as well?
  • If the answer is Yes and No, is it a necessarily a bad thing? One may introduce a new GA event that does not need to be consulted...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants