docs(contributing, conventions): proofread and add additional info #5228
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jcfranco
approved these changes
Sep 2, 2022
There was a problem hiding this comment.
📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖
📖🤩📖📖📖📖📖🤩📖📖🤩🤩📖📖🤩📖📖📖📖📖🤩📖🤩🤩🤩🤩📖🤩🤩🤩🤩📖🤩📖
📖🤩📖📖📖📖📖🤩📖🤩📖📖🤩📖🤩📖📖📖📖📖🤩📖🤩📖📖📖📖🤩📖📖📖📖🤩📖
📖🤩📖📖🤩📖📖🤩📖🤩📖📖🤩📖🤩📖📖🤩📖📖🤩📖🤩🤩🤩📖📖🤩🤩🤩📖📖🤩📖
📖🤩📖🤩📖🤩📖🤩📖🤩📖📖🤩📖🤩📖🤩📖🤩📖🤩📖🤩📖📖📖📖🤩📖📖📖📖📖📖
📖📖🤩📖📖📖🤩📖📖📖🤩🤩📖📖📖🤩📖📖📖🤩📖📖🤩🤩🤩🤩📖🤩🤩🤩🤩📖🤩📖
📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖📖
It'd be nice to update the writing stories section, but we can tackle this separately.
| - Use double quotes (`"`) for the values of properties/attributes and event details. | ||
| - Only use single quotes (`'`) as apostrophes. | ||
| - No links or URLs allowed in descriptions. If a link is necessary, a [custom JSDoc tag](https://stenciljs.com/docs/docs-json#custom-jsdocs-tags) should be added and parsed in the SDK site. | ||
| - Refrain from using "e.g." or "i.e." references. Leverage "such as" (or similar) where examples are referenced. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue: #3818
Summary