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

CPLAT-12081 Readme Improvements #487

Merged
merged 17 commits into from
Sep 3, 2020
Merged

CPLAT-12081 Readme Improvements #487

merged 17 commits into from
Sep 3, 2020

Conversation

aaronlademann-wf
Copy link
Contributor

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

  • 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 Client Platform 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

@aviary2-wf
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.

Looks great, just a couple things here and there. Sorry I put off reviewing this for so long! 😬

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
doc/props_mixin_component_composition.md Outdated Show resolved Hide resolved
doc/props_mixin_component_composition.md Outdated Show resolved Hide resolved
doc/props_mixin_component_composition.md Outdated Show resolved Hide resolved
@aaronlademann-wf
Copy link
Contributor Author

Sorry I lost track of this @greglittlefield-wf - all feedback has been addressed.

@rmconsole4-wk rmconsole4-wk changed the title Readme Improvements CPLAT-12081 Readme Improvements Sep 3, 2020
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

@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

@rmconsole4-wk rmconsole4-wk merged commit 1a3a2eb into master Sep 3, 2020
@rmconsole4-wk rmconsole4-wk deleted the readme-improvements branch September 3, 2020 17:32
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