over_react icon indicating copy to clipboard operation
over_react copied to clipboard

FED-1978 Null-safe props documentation

Open greglittlefield-wf opened this issue 1 year ago • 2 comments

Motivation

We needed some documentation on required props and how they relate to null safety.

We also need to update code blocks in documentation to use null safety.

Changes

  • [x] Small README cleanup
    • [x] Make null safety the featured migration guide
    • [x] Add basic docs around function components (can't believe we didn't have any 😓) #boyscouting
  • [x] Add required props documentation
  • [x] Update code blocks with null safety
    • [x] In README
    • [x] In doc comments

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

greglittlefield-wf avatar May 06 '24 18:05 greglittlefield-wf

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.

aviary3-wk avatar May 06 '24 18:05 aviary3-wk

Okay @aaronlademann-wf and @sydneyjodon-wk, I think I've addressed all your feedback!

greglittlefield-wf avatar May 10 '24 21:05 greglittlefield-wf