docs: add object naming best practices#9
Open
NTchrist wants to merge 3 commits into
Open
Conversation
georgiastuart
requested changes
Jun 24, 2026
georgiastuart
left a comment
georgiastuart
left a comment
Collaborator
There was a problem hiding this comment.
I think moving the call to action (use these characters) above the reasons why to not use other characters is the most clear.
|
|
||
| However, a forward slash should not be used within the name of an individual file or directory. | ||
|
|
||
| For broad compatibility with tools, libraries, and filesystems, use lower-case letters, numbers, spaces, hyphens (`-`), underscores (`_`), and periods (`.`) in file and folder names. Avoid unnecessary special characters, names that differ only by capitalization, and leading or trailing spaces or periods. |
Collaborator
There was a problem hiding this comment.
Can you move this to the top of the section to emphasize it as what TO do over what NOT to do?
| ## Best Practices | ||
|
|
||
| ### Naming Conventions | ||
|
|
Collaborator
There was a problem hiding this comment.
Mark this clearly as "this don't use these characters and why." I think it may be misinterpreted at a glance.
|
|
||
| However, a forward slash should not be used within the name of an individual file or directory. | ||
|
|
||
| For broad compatibility with tools, libraries, and filesystems, use lower-case letters, numbers, spaces, hyphens (`-`), underscores (`_`), and periods (`.`) in file and folder names. Avoid unnecessary special characters, names that differ only by capitalization, and leading or trailing spaces or periods. |
Collaborator
There was a problem hiding this comment.
Move to the top to emphasize what TO do rather than what not to do.
Collaborator
|
Whoops I thought it hadn't submitted my review the first time so there are two pretty identical reviews |
NTchrist
force-pushed
the
docs-update-tips
branch
from
8ebce0b to
17c5d6b
Compare
Author
|
I believe that is what you asked for. Please review at your convenience. |
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
3 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.
Adds naming convention recommendations for objects, guidance for compatibility with downstream filesystems, tools, and libraries.