docs: add examples for variable naming#39
Open
leviFrosty wants to merge 1 commit intosilvermine:masterfrom
Open
docs: add examples for variable naming#39leviFrosty wants to merge 1 commit intosilvermine:masterfrom
leviFrosty wants to merge 1 commit intosilvermine:masterfrom
Conversation
yokuze
requested changes
Nov 3, 2025
coding-standards.md
Outdated
|
|
||
| Example: | ||
|
|
||
| ```javascript |
Contributor
There was a problem hiding this comment.
Thanks for adding this! I think it'll be helpful to have a concise reference for devs to scan.
Could you:
- Make the example TypeScript
- Format the example according to our ESLint standards
?
Thanks
There was a problem hiding this comment.
It would be useful to also include an example of an acronym e.g. URL.
b7195a5 to
ea38af7
Compare
Author
|
I have updated the example to be Typescript. To align better with actual coding problems, I've centered the example around an ApiClient, not just abstract variables. I included some missing examples as well (protected & static methods). I also formatted the document to be aligned with our existing formatting standards. @yokuze @velocitysystems I've added a naming example using "URL" acronym. Thanks everyone! |
ea38af7 to
7e7bcaa
Compare
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
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.
Updates
coding-standards.md:493-536to include new example for variable naming based on provided standards for easier visual comprehension.