-
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
CPLAT-12081 Readme Improvements #487
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.
Looks great, just a couple things here and there. Sorry I put off reviewing this for so long! 😬
…provements # Conflicts: # README.md
+ Change http links to https + Add a README file to the root of example to satisfy example requirements (https://dart.dev/tools/pub/package-layout#examples)
Sorry I lost track of this @greglittlefield-wf - all feedback has been addressed. |
# Conflicts: # README.md
8edcb09
to
c499377
Compare
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
As I was doing a full in-depth read through our README this morning following the awesome 3.5.0 release, I noticed a few things that were wrong, or that just needed a little love/updating.
Changes
Misc. updates and improvements to the README. I broke it all up into fairly granular commits if you want to digest the changes that way.
Release Notes
Improve documentation
Review
See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.
Please review: @greglittlefield-wf @sydneyjodon-wk @joebingham-wk
QA Checklist
Merge Checklist
While we perform many automated checks before auto-merging, some manual checks are needed: