Skip to content

Commit

Permalink
Update file and directory name guidance in style guide (github#30424)
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanpalm authored Aug 31, 2022
1 parent d25f7ab commit 7cd3fb4
Showing 1 changed file with 9 additions and 18 deletions.
27 changes: 9 additions & 18 deletions contributing/content-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,15 @@ schedule:
- cron: "40 19 * * *"
```
### File and directory names
Use inline codeblocks to refer to file and directory names. If a file type generally follows a specific capitalization convention, such as all caps for README files, use the established convention.
- **Use:** In your `README.md` file, add info about your repository.
- **Use:** In your `.github/workflows/` directory, create the `example-workflow.yml` file.
- **Avoid:** In your _.github/workflows/_ directory, create the `example-workflow.yml` file.
- **Avoid:** Delete the **example.js** file.
### Indentation
In YAML examples, such as actions and workflow files, use two spaces to indent lines within nested lists and block sequences.
Expand Down Expand Up @@ -500,29 +509,11 @@ Format checkbox names in bold and omit the word “checkbox.” To describe choo
- **Use:** Select **Enable for all new repositories**.
- **Avoid:** Check the “Enable for all new repositories” checkbox.
### Directory names
Use sentence style capitalization. You can use internal capital letters in directory and folder names for readability. Format directory names in bold if you direct someone to select, type, or otherwise interact with the name.
- **Use:** In your .github/workflows directory, create a new file.
- **Use:** Select your **.github/workflows** directory.
- **Avoid:** In your *.github/workflows* directory, select the workflow you wish to edit.
- **Avoid:** In your `.github/workflows` directory, select the workflow you wish to edit.
### Dynamic text
Use capital letters to indicate text that changes in the user interface or that the user needs to supply in a command or code snippet.
- **Use:** Click **Add USERNAME to REPONAME**.
### File names
Use title style capitalization. If a file type generally follows a different capitalization convention, such as all caps for README files, use the established convention. You can use internal capital letters in file names for readability. Format file names in bold if you direct someone to select, type, or otherwise interact with the name.
- **Use:** In your README.md file, add info about your repository.
- **Use:** Enter **MyWorkflow.yml**.
- **Avoid:** In your *README.md* file, add info about your repository.
- **Avoid:** In your `README.md` file, add info about your repository.
### Lists and list items
Format lists and clickable list items in bold. To describe interacting with a list, such as a dropdown menu or UI element that expands, regardless of whether the list name is a word or an octicon, write "select." To describe choosing a list item, write "click."
Expand Down

0 comments on commit 7cd3fb4

Please sign in to comment.