[ CodeStyle ] Add base code style guidelines #19
Merged
+81
−0
Conversation
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
jamesnw
commented
Jul 2, 2025
docs/component-api.md
Outdated
|
|
||
| ### Events | ||
|
|
||
| TODO |
There was a problem hiding this comment.
I think there are likely others in this group who have thought through the event and method naming conventions more than I have, and would welcome their input on what should be in a guidelines document.
jamesnw
commented
Jul 2, 2025
gfellerph
reviewed
Jul 8, 2025
Co-authored-by: Philipp Gfeller <1659006+gfellerph@users.noreply.github.com>
jamesnw
commented
Jul 8, 2025
jamesnw
changed the title
|
@jamesnw Let's get this file merged in, and then we can add PRs for some of the specifics. |
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.
This is a draft of the code style guidelines. It is intentionally a skeleton, with individual decisions happening as subsequent PRs.
For instance, #21 builds off of this to define a namespace, and all conversation related to that will happen in that PR.
In our call, we decided that as we build this out, these pull requests will be open for a week, with the hope that is enough time for people to review and discuss. They can also be action items in the weekly meeting.
It draws heavily from @bradfrost's document at https://vanilla-full.netlify.app/?path=/docs/documentation-guidelines--docs. Also, thanks to @gfellerph for feedback on an earlier draft.
Addresses #13