Skip to content

Conversation

@nearestnabors
Copy link
Contributor

Adding the style guide we have started using for new content internally. When referring to the styleguide in PR reviews, call out individual rules using their numbers. Cheers!

Issue #, if available:

Description of changes:

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Adding the style guide we have started using for new content internally. When referring to the styleguide in PR reviews, call out individual rules using their numbers. Cheers!
Copy link
Contributor

@abdallahshaban557 abdallahshaban557 left a comment

Choose a reason for hiding this comment

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

LGTM!

R L Nabors and others added 7 commits November 11, 2022 09:06
Co-authored-by: Tim Schmelter <schmelte@amazon.com>
Co-authored-by: Tim Schmelter <schmelte@amazon.com>
Co-authored-by: Tim Schmelter <schmelte@amazon.com>
Co-authored-by: Tim Schmelter <schmelte@amazon.com>
Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>
Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>
Copy link
Contributor

@katieklein katieklein left a comment

Choose a reason for hiding this comment

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

I love it. LGTM

katieklein
katieklein previously approved these changes Nov 17, 2022
Copy link
Contributor

@cshfang cshfang left a comment

Choose a reason for hiding this comment

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

🤩


* Key names are enclosed in `"`
* Values are between `"` instead of `'`
* No comments
Copy link
Contributor

Choose a reason for hiding this comment

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

Can/should we include recommendations for adding context/descriptions to specific properties in lieu of inline comments?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If you think so, please suggest an edit.

R L Nabors and others added 4 commits November 18, 2022 14:12
Co-authored-by: Tim Schmelter <schmelte@amazon.com>
Co-authored-by: Tim Schmelter <schmelte@amazon.com>
Co-authored-by: Tim Schmelter <schmelte@amazon.com>
Copy link
Contributor

@cwomack cwomack left a comment

Choose a reason for hiding this comment

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

LGTM!

@katieklein katieklein self-requested a review November 21, 2022 19:40
@katieklein katieklein merged commit fb2b7d3 into main Nov 21, 2022
@katieklein katieklein deleted the styleguides branch November 21, 2022 19:41
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.

7 participants