-
Notifications
You must be signed in to change notification settings - Fork 58
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
FED-2040 Placeholder null safety migration guide #910
Conversation
Security InsightsNo security relevant content was detected by automated scans. Action Items
Questions or Comments? Reach out on Slack: #support-infosec. |
There was a problem hiding this 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. |
There was a problem hiding this comment.
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":
> ⚠️ 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. |
There was a problem hiding this comment.
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!
|
||
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? --> |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay perfect! Thank you!
<!-- 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? --> |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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!
There was a problem hiding this 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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+10
@Workiva/release-management-p |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 from RM
Motivation
Add placeholder migration guide, with:
Changes
Release Notes
Review
See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.
Please review:
QA Checklist
Merge Checklist
While we perform many automated checks before auto-merging, some manual checks are needed: