From 7cd3fb4d5edcace55482d6e1220b4109a9ab3b20 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 31 Aug 2022 13:03:51 -0700 Subject: [PATCH] Update file and directory name guidance in style guide (#30424) --- contributing/content-style-guide.md | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-) diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index 72c51cb965..c50374f2b8 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -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. @@ -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."