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

docs(readme): highlight high level concepts #2205

Merged
merged 5 commits into from
Apr 15, 2021

Conversation

alexforsyth
Copy link
Contributor

Issue

Issue number, if available, prefixed with "#"

Description

We wanted to quickly provide an easy way to highlight some of the core concepts of AWS SDK v3 that are largely similar between clients. We're putting this at the top level readme. This is by no means an exhaustive list and we'd love comments on other topics people would like included here.

Testing

How was this change tested?

Additional context

Add any other context about the PR here.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@codecov-io
Copy link

codecov-io commented Apr 1, 2021

Codecov Report

❗ No coverage uploaded for pull request base (main@325d6b4). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2205   +/-   ##
=======================================
  Coverage        ?   61.83%           
=======================================
  Files           ?      453           
  Lines           ?    23287           
  Branches        ?     5516           
=======================================
  Hits            ?    14399           
  Misses          ?     8888           
  Partials        ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 325d6b4...3e59d48. Read the comment docs.

Copy link
Member

@trivikr trivikr left a comment

Choose a reason for hiding this comment

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

Split sentences over multiple lines.
We don't follow a printWidth for README. It can be 120 - same as prettier.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
alexforsyth and others added 2 commits April 2, 2021 12:32
Co-authored-by: Trivikram Kamat <16024985+trivikr@users.noreply.github.com>
Co-authored-by: Trivikram Kamat <16024985+trivikr@users.noreply.github.com>
@aws-sdk-js-automation
Copy link

AWS CodeBuild CI Report

  • CodeBuild project: sdk-staging-test
  • Commit ID: fc748dd
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@trivikr
Copy link
Member

trivikr commented Apr 8, 2021

The commit can be changed to use less words:
docs(readme): highlight high level concepts

@trivikr trivikr changed the title chore(readme): Improve dev experience by highlighting some high level concepts in the top level readme docs(readme): highlight high level concepts Apr 13, 2021
@alexforsyth alexforsyth merged commit 39011c8 into aws:main Apr 15, 2021
@github-actions
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants