Skip to content

Commit

Permalink
Update StyleGuide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mdlinville authored Aug 20, 2024
1 parent 3842488 commit d091691
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions StyleGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1422,11 +1422,11 @@ Many popular code editors feature extensions that can highlight `TODO`s across t
## Word usage guidelines
This section logs decisions about dictionary words to use and avoid. Add specific guidelines we decide as a team to this section. Refer also to [Technical terminology](#technical-termilogy) for technical terms that may not be in a dictionary.
This section logs decisions about dictionary words to use and avoid. Add specific guidelines we decide as a team to this section. Refer also to [Technical terminology](#technical-termilogy) for technical terms that may not be in a dictionary.
### Directories and folders
- Use "directory" to refer to a filesystem directory, either locally or in a VM. For example, "Compress the directory into a `zip` archive."
- Use "folder" to refer to a folder within a UI, such as a web UI or an IDE. For example "Create a folder in your CockroachDB Cloud organization."
- Use "folder" to refer to a folder within a UI, such as a web UI or an IDE. For example, "Create a folder in your CockroachDB Cloud organization."
### Technical terminology
This section logs decisions about software branding and terminology. In general, align third-party branding with that brand's usage. For example, the [PostgreSQL project](https://www.postgresql.org/) uses the word "PostgreSQL" with that capitalization. Add specific guidelines we decide as a team to this table.
Expand Down

0 comments on commit d091691

Please sign in to comment.