feat: document code fragment rules#309
Merged
vados-cosmonic merged 3 commits intobytecodealliance:mainfrom Sep 8, 2025
Merged
Conversation
This commit adds a basic style guide to the contributing documentation, with rules around how we currently do executable code fragments. Resolves bytecodealliance#239
Collaborator
Author
|
Hey @itowlson / @kate-goldenring would ya'll mind reviewing this? |
itowlson
reviewed
Sep 7, 2025
Collaborator
itowlson
left a comment
itowlson
left a comment
There was a problem hiding this comment.
The style guide looks fine but there are some unrelated changes which I think are not correct.
itowlson
approved these changes
Sep 8, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This commit adds a basic style guide to the contributing documentation, with rules around how we currently do executable code fragments.
Resolves #239