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

FED-2040 Placeholder null safety migration guide #910

Merged
merged 8 commits into from
Apr 18, 2024

Conversation

sydneyjodon-wk
Copy link
Contributor

Motivation

Add placeholder migration guide, with:

Changes

  • add placeholder migration guide

Release Notes

Review

See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.

Please review:

QA Checklist

  • Tests were updated and provide good coverage of the changeset and other affected code
  • Manual testing was performed if needed

Merge Checklist

While we perform many automated checks before auto-merging, some manual checks are needed:

  • A Frontend Frameworks Design member has reviewed these changes
  • There are no unaddressed comments - this check can be automated if reviewers use the "Request Changes" feature
  • For release PRs - Version metadata in Rosie comment is correct

@aviary3-wk
Copy link

Security Insights

No security relevant content was detected by automated scans.

Action Items

  • Review PR for security impact; comment "security review required" if needed or unsure
  • Verify aviary.yaml coverage of security relevant code

Questions or Comments? Reach out on Slack: #support-infosec.

Copy link
Contributor

@greglittlefield-wf greglittlefield-wf left a comment

Choose a reason for hiding this comment

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

Just a couple things, otherwse this looks good to me!


<!-- TODO - do we need to list a reasons props could be required?? If a prop is defaulted, does that make it required too? -->

> ⚠️ Making a prop required with the `late` keyword can be a breaking change if consumers are not always setting the prop.
Copy link
Contributor

Choose a reason for hiding this comment

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

#fyi (what you have is fine) there's a built-in way to do warning callouts with "alerts":

Suggested change
> ⚠️ Making a prop required with the `late` keyword can be a breaking change if consumers are not always setting the prop.
> [!WARNING]
> Making a prop required with the `late` keyword can be a breaking change if consumers are not always setting the prop.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh that's awesome!! Thank you!

doc/null_safety/null_safe_migration.md Show resolved Hide resolved
doc/null_safety/null_safe_migration.md Show resolved Hide resolved

To determine if a prop should be nullable or not, first consider if the prop is required.

<!-- TODO - do we need to list a reasons props could be required?? If a prop is defaulted, does that make it required too? -->
Copy link
Contributor

Choose a reason for hiding this comment

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

I'll go into more depth about this in my null safe props PR

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay perfect! Thank you!

Comment on lines 81 to 82
<!-- TODO - not really sure how to explain this or if there is a solution besides manual overriding?
Is this fixed in the Workiva version of the tool that we should link to? -->
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@greglittlefield-wf do you have any thoughts on this one?

Copy link
Contributor

Choose a reason for hiding this comment

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

Good question; we could add instructions for running the migrator tool with the fix in my branch/CL that's linked in that Dart issue.

It's a little involved since it involves cloning and partially setting up the Dart SDK, so how about I write that up and PR that separately?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That would be great! Thank you!

@sydneyjodon-wk sydneyjodon-wk marked this pull request as ready for review April 18, 2024 22:35
Copy link
Contributor

@greglittlefield-wf greglittlefield-wf left a comment

Choose a reason for hiding this comment

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

  • Docs look good
  • All links work

+10

Copy link
Contributor

@greglittlefield-wf greglittlefield-wf left a comment

Choose a reason for hiding this comment

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

+10

@greglittlefield-wf
Copy link
Contributor

@Workiva/release-management-p

Copy link

@rmconsole-wf rmconsole-wf left a comment

Choose a reason for hiding this comment

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

+1 from RM

@rmconsole2-wf rmconsole2-wf merged commit 9079dff into master Apr 18, 2024
7 checks passed
@rmconsole2-wf rmconsole2-wf deleted the placeholder-null-safety-migration-guide branch April 18, 2024 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants