Skip to content

Update README.md to call more attention to SDK instability #3

Open
MaxRobinson wants to merge 1 commit intoamazr:developfrom
MaxRobinson:patch-1
Open

Update README.md to call more attention to SDK instability #3
MaxRobinson wants to merge 1 commit intoamazr:developfrom
MaxRobinson:patch-1

Conversation

@MaxRobinson
Copy link
Copy Markdown

@MaxRobinson MaxRobinson commented Apr 30, 2025

Before this PR

Not enough warnings about SDK instability

After this PR

==COMMIT_MSG==
==COMMIT_MSG==

Possible downsides?

Are Docs needed?

Comment thread README.md
@@ -5,7 +5,9 @@

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

"Wow, what a way to instill confidence in your users! Adding a warning about the SDK's instability and referencing Hyrum's Law is a nice touch, but maybe consider proofreading your warning message. 'Responsiblility' should be 'responsibility'. Also, adding a newline at the end of the file is a good practice."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants