From aa1be84d5408fabd2883d708ebbc834091a80b40 Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Thu, 8 Feb 2024 13:38:29 +0530 Subject: [PATCH 01/13] docs-infra: Add vale for style-guide lint on docs --- .github/styles/Blog/BrandName.yml | 16 ++++++++++++++ .github/styles/Blog/ComponentNaming.yml | 24 ++++++++++++++++++++ .github/styles/Blog/ComposedWords.yml | 12 ++++++++++ .github/styles/Blog/NamingConventions.yml | 17 ++++++++++++++ .github/styles/Blog/NoCompanyName.yml | 13 +++++++++++ .github/styles/Blog/Typos.yml | 11 +++++++++ .github/workflows/vale-action.yml | 23 +++++++++++++++++++ .gitignore | 4 ++++ .vale.ini | 27 +++++++++++++++++++++++ 9 files changed, 147 insertions(+) create mode 100644 .github/styles/Blog/BrandName.yml create mode 100644 .github/styles/Blog/ComponentNaming.yml create mode 100644 .github/styles/Blog/ComposedWords.yml create mode 100644 .github/styles/Blog/NamingConventions.yml create mode 100644 .github/styles/Blog/NoCompanyName.yml create mode 100644 .github/styles/Blog/Typos.yml create mode 100644 .github/workflows/vale-action.yml create mode 100644 .vale.ini diff --git a/.github/styles/Blog/BrandName.yml b/.github/styles/Blog/BrandName.yml new file mode 100644 index 00000000000..b95387c5851 --- /dev/null +++ b/.github/styles/Blog/BrandName.yml @@ -0,0 +1,16 @@ +# Without a non-breaking space, brand names can be split in the middle, with the start and end on two different lines. +extends: substitution +message: Use a non-breaking space for brand name ('%s' instead of '%s') +level: error +ignorecase: true +# swap maps tokens in form of bad: good +# for more information: https://vale.sh/docs/topics/styles/#substitution +swap: + Material UI: Material UI + MUI X: MUI X + Base UI: Base UI + MUI System: MUI System + MUI Store: MUI Store + MUI Core: MUI Core + MUI Toolpad: MUI Toolpad + MUI Connect: MUI Connect diff --git a/.github/styles/Blog/ComponentNaming.yml b/.github/styles/Blog/ComponentNaming.yml new file mode 100644 index 00000000000..138f7c303a7 --- /dev/null +++ b/.github/styles/Blog/ComponentNaming.yml @@ -0,0 +1,24 @@ +extends: substitution +message: Unless you're referring to the general concept, consider using '%s' instead of '%s'. +level: suggestion +ignorecase: false +# swap maps tokens in form of bad: good +# for more information: https://vale.sh/docs/topics/styles/#substitution +swap: + # Capitalize + data grid: Data Grid + date picker: Date Picker + Data grid: Data Grid + Date picker: Date Picker + Time picker: Time Picker + Date [t|T]ime picker: Date Time Picker + Date [r|R]ange picker: Date Range Picker + Time [r|R]ange picker: Time Range Picker + Date [t|T]ime [r|R]ange picker: Date Time Range Picker + time picker: Time Picker + date time picker: Date Time Picker + date range picker: Date Range Picker + time range picker: Time Range Picker + date time range picker: Date Time Range Picker + # use Data Grid instead of grid + the grid: the Data Grid diff --git a/.github/styles/Blog/ComposedWords.yml b/.github/styles/Blog/ComposedWords.yml new file mode 100644 index 00000000000..cded294d532 --- /dev/null +++ b/.github/styles/Blog/ComposedWords.yml @@ -0,0 +1,12 @@ +extends: substitution +message: To be consistent with the rest of the documentation, consider using '%s' instead of '%s'. +level: warning +ignorecase: true +# swap maps tokens in form of bad: good +swap: + 'sub-component': subcomponent + 'sub-components': subcomponents + 'sub component': subcomponent + 'sub components': subcomponents + 'use-case': 'use case' + 'usecase': 'use case' diff --git a/.github/styles/Blog/NamingConventions.yml b/.github/styles/Blog/NamingConventions.yml new file mode 100644 index 00000000000..116d28a576a --- /dev/null +++ b/.github/styles/Blog/NamingConventions.yml @@ -0,0 +1,17 @@ +extends: substitution +message: To be consistent with capitalization, consider using '%s' instead of '%s'. +level: warning +ignorecase: false +# swap maps tokens in form of bad: good +# for more information: https://vale.sh/docs/topics/styles/#substitution +swap: + api: API + Api: API + typescript: TypeScript + Typescript: TypeScript + ts: TypeScript + TS: TypeScript + javascript: JavaScript + Javascript: JavaScript + css: CSS + Css: CSS diff --git a/.github/styles/Blog/NoCompanyName.yml b/.github/styles/Blog/NoCompanyName.yml new file mode 100644 index 00000000000..dacecf36f4a --- /dev/null +++ b/.github/styles/Blog/NoCompanyName.yml @@ -0,0 +1,13 @@ +extends: existence +message: We avoid referencing the company name '%s'. Instead you can reference a product or the team. +level: warning +ignorecase: false +tokens: + - 'MUI \w+' +exceptions: + - 'MUI X' + - 'MUI System' + - 'MUI Store' + - 'MUI Core' + - 'MUI Toolpad' + - 'MUI Connect' diff --git a/.github/styles/Blog/Typos.yml b/.github/styles/Blog/Typos.yml new file mode 100644 index 00000000000..9397f615325 --- /dev/null +++ b/.github/styles/Blog/Typos.yml @@ -0,0 +1,11 @@ +extends: substitution +message: Do you mean '%s' instead of '%s'? +level: error +ignorecase: true +# swap maps tokens in form of bad: good +# for more information: https://vale.sh/docs/topics/styles/#substitution +swap: + bellow: below + eg: e.g. + eg.: e.g. + 'e.g ': 'e.g. ' diff --git a/.github/workflows/vale-action.yml b/.github/workflows/vale-action.yml new file mode 100644 index 00000000000..61078d7162e --- /dev/null +++ b/.github/workflows/vale-action.yml @@ -0,0 +1,23 @@ +name: Vale action + +on: [pull_request] + +permissions: {} + +jobs: + vale: + name: runner / vale + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - uses: errata-ai/vale-action@c4213d4de3d5f718b8497bd86161531c78992084 # v2.0.1 + with: + reporter: github-pr-review + files: docs/data + env: + # Required, set by GitHub actions automatically: + # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} diff --git a/.gitignore b/.gitignore index ba0d2398e63..0e2fa3684e6 100644 --- a/.gitignore +++ b/.gitignore @@ -60,3 +60,7 @@ test-results .yarn-playwright-cache /test/regressions/screenshots/** + +# vale downloaded config +.github/styles/Google +.github/styles/write-good diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 00000000000..89db22dcc88 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,27 @@ +#Config vale. More information at https://docs.errata.ai/vale/config +StylesPath = .github/styles +MinAlertLevel = suggestion + +# Run `vale sync` to include packages: https://vale.sh/hub/google/ +Packages = Google + +[*.md] +# Ignore code injection which start with {{... +BlockIgnores = {{.* + +# Custom syle +# BasedOnStyles = Blog + +Blog.ComposedWords = YES +Blog.NamingConventions = YES +Blog.Typos = YES + +# Google: +Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'. +Google.GenderBias = YES # Avoid gendered profession +Google.OxfordComma = YES +Google.Quotes = YES # Commas and periods go inside quotation marks. +Google.Spelling = YES #In general, use American spelling (word ending with 'nised' or 'logue') +Google.We = YES # Try to avoid using first-person plural +Google.Latin = YES # Try to avoid latin expressions e.g. and i.e. + From f6892ef6933f783fa229b211c5cf5190cacccdf8 Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Sat, 10 Feb 2024 00:55:49 +0530 Subject: [PATCH 02/13] fix: Jan review --- .github/styles/Blog/ComposedWords.yml | 3 +++ .github/styles/Blog/Typos.yml | 3 +-- .gitignore | 4 ++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/styles/Blog/ComposedWords.yml b/.github/styles/Blog/ComposedWords.yml index cded294d532..944c51eed34 100644 --- a/.github/styles/Blog/ComposedWords.yml +++ b/.github/styles/Blog/ComposedWords.yml @@ -10,3 +10,6 @@ swap: 'sub components': subcomponents 'use-case': 'use case' 'usecase': 'use case' + 'client side': 'client-side' + 'server side': 'server-side' + diff --git a/.github/styles/Blog/Typos.yml b/.github/styles/Blog/Typos.yml index 9397f615325..c596dad7c11 100644 --- a/.github/styles/Blog/Typos.yml +++ b/.github/styles/Blog/Typos.yml @@ -4,8 +4,7 @@ level: error ignorecase: true # swap maps tokens in form of bad: good # for more information: https://vale.sh/docs/topics/styles/#substitution -swap: - bellow: below +swap: eg: e.g. eg.: e.g. 'e.g ': 'e.g. ' diff --git a/.gitignore b/.gitignore index 0e2fa3684e6..ffc8c9c4e4a 100644 --- a/.gitignore +++ b/.gitignore @@ -62,5 +62,5 @@ test-results /test/regressions/screenshots/** # vale downloaded config -.github/styles/Google -.github/styles/write-good +.github/styles/* +!.github/styles/Blog \ No newline at end of file From 82a571b3e99f2da8aa90a7f9c009db4dd03fa4a3 Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Tue, 20 Feb 2024 18:38:54 +0530 Subject: [PATCH 03/13] fix: Prettier --- .github/styles/Blog/ComposedWords.yml | 1 - .github/styles/Blog/Typos.yml | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/styles/Blog/ComposedWords.yml b/.github/styles/Blog/ComposedWords.yml index 944c51eed34..bb3ba7d3f16 100644 --- a/.github/styles/Blog/ComposedWords.yml +++ b/.github/styles/Blog/ComposedWords.yml @@ -12,4 +12,3 @@ swap: 'usecase': 'use case' 'client side': 'client-side' 'server side': 'server-side' - diff --git a/.github/styles/Blog/Typos.yml b/.github/styles/Blog/Typos.yml index c596dad7c11..6d8babd6736 100644 --- a/.github/styles/Blog/Typos.yml +++ b/.github/styles/Blog/Typos.yml @@ -4,7 +4,7 @@ level: error ignorecase: true # swap maps tokens in form of bad: good # for more information: https://vale.sh/docs/topics/styles/#substitution -swap: +swap: eg: e.g. eg.: e.g. 'e.g ': 'e.g. ' From 9699729a00d440dca0295d1e52dd8172130b68e3 Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Wed, 21 Feb 2024 16:34:03 +0530 Subject: [PATCH 04/13] feat: Use config sharing --- .github/styles/Blog/BrandName.yml | 16 --------------- .github/styles/Blog/ComponentNaming.yml | 24 ----------------------- .github/styles/Blog/ComposedWords.yml | 14 ------------- .github/styles/Blog/NamingConventions.yml | 17 ---------------- .github/styles/Blog/NoCompanyName.yml | 13 ------------ .github/styles/Blog/Typos.yml | 10 ---------- .gitignore | 3 +-- .vale.ini | 14 +++++++------ 8 files changed, 9 insertions(+), 102 deletions(-) delete mode 100644 .github/styles/Blog/BrandName.yml delete mode 100644 .github/styles/Blog/ComponentNaming.yml delete mode 100644 .github/styles/Blog/ComposedWords.yml delete mode 100644 .github/styles/Blog/NamingConventions.yml delete mode 100644 .github/styles/Blog/NoCompanyName.yml delete mode 100644 .github/styles/Blog/Typos.yml diff --git a/.github/styles/Blog/BrandName.yml b/.github/styles/Blog/BrandName.yml deleted file mode 100644 index b95387c5851..00000000000 --- a/.github/styles/Blog/BrandName.yml +++ /dev/null @@ -1,16 +0,0 @@ -# Without a non-breaking space, brand names can be split in the middle, with the start and end on two different lines. -extends: substitution -message: Use a non-breaking space for brand name ('%s' instead of '%s') -level: error -ignorecase: true -# swap maps tokens in form of bad: good -# for more information: https://vale.sh/docs/topics/styles/#substitution -swap: - Material UI: Material UI - MUI X: MUI X - Base UI: Base UI - MUI System: MUI System - MUI Store: MUI Store - MUI Core: MUI Core - MUI Toolpad: MUI Toolpad - MUI Connect: MUI Connect diff --git a/.github/styles/Blog/ComponentNaming.yml b/.github/styles/Blog/ComponentNaming.yml deleted file mode 100644 index 138f7c303a7..00000000000 --- a/.github/styles/Blog/ComponentNaming.yml +++ /dev/null @@ -1,24 +0,0 @@ -extends: substitution -message: Unless you're referring to the general concept, consider using '%s' instead of '%s'. -level: suggestion -ignorecase: false -# swap maps tokens in form of bad: good -# for more information: https://vale.sh/docs/topics/styles/#substitution -swap: - # Capitalize - data grid: Data Grid - date picker: Date Picker - Data grid: Data Grid - Date picker: Date Picker - Time picker: Time Picker - Date [t|T]ime picker: Date Time Picker - Date [r|R]ange picker: Date Range Picker - Time [r|R]ange picker: Time Range Picker - Date [t|T]ime [r|R]ange picker: Date Time Range Picker - time picker: Time Picker - date time picker: Date Time Picker - date range picker: Date Range Picker - time range picker: Time Range Picker - date time range picker: Date Time Range Picker - # use Data Grid instead of grid - the grid: the Data Grid diff --git a/.github/styles/Blog/ComposedWords.yml b/.github/styles/Blog/ComposedWords.yml deleted file mode 100644 index bb3ba7d3f16..00000000000 --- a/.github/styles/Blog/ComposedWords.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: substitution -message: To be consistent with the rest of the documentation, consider using '%s' instead of '%s'. -level: warning -ignorecase: true -# swap maps tokens in form of bad: good -swap: - 'sub-component': subcomponent - 'sub-components': subcomponents - 'sub component': subcomponent - 'sub components': subcomponents - 'use-case': 'use case' - 'usecase': 'use case' - 'client side': 'client-side' - 'server side': 'server-side' diff --git a/.github/styles/Blog/NamingConventions.yml b/.github/styles/Blog/NamingConventions.yml deleted file mode 100644 index 116d28a576a..00000000000 --- a/.github/styles/Blog/NamingConventions.yml +++ /dev/null @@ -1,17 +0,0 @@ -extends: substitution -message: To be consistent with capitalization, consider using '%s' instead of '%s'. -level: warning -ignorecase: false -# swap maps tokens in form of bad: good -# for more information: https://vale.sh/docs/topics/styles/#substitution -swap: - api: API - Api: API - typescript: TypeScript - Typescript: TypeScript - ts: TypeScript - TS: TypeScript - javascript: JavaScript - Javascript: JavaScript - css: CSS - Css: CSS diff --git a/.github/styles/Blog/NoCompanyName.yml b/.github/styles/Blog/NoCompanyName.yml deleted file mode 100644 index dacecf36f4a..00000000000 --- a/.github/styles/Blog/NoCompanyName.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: We avoid referencing the company name '%s'. Instead you can reference a product or the team. -level: warning -ignorecase: false -tokens: - - 'MUI \w+' -exceptions: - - 'MUI X' - - 'MUI System' - - 'MUI Store' - - 'MUI Core' - - 'MUI Toolpad' - - 'MUI Connect' diff --git a/.github/styles/Blog/Typos.yml b/.github/styles/Blog/Typos.yml deleted file mode 100644 index 6d8babd6736..00000000000 --- a/.github/styles/Blog/Typos.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: substitution -message: Do you mean '%s' instead of '%s'? -level: error -ignorecase: true -# swap maps tokens in form of bad: good -# for more information: https://vale.sh/docs/topics/styles/#substitution -swap: - eg: e.g. - eg.: e.g. - 'e.g ': 'e.g. ' diff --git a/.gitignore b/.gitignore index ffc8c9c4e4a..92acc846d55 100644 --- a/.gitignore +++ b/.gitignore @@ -62,5 +62,4 @@ test-results /test/regressions/screenshots/** # vale downloaded config -.github/styles/* -!.github/styles/Blog \ No newline at end of file +.github/styles/ \ No newline at end of file diff --git a/.vale.ini b/.vale.ini index 89db22dcc88..0fc2d9bb478 100644 --- a/.vale.ini +++ b/.vale.ini @@ -2,19 +2,21 @@ StylesPath = .github/styles MinAlertLevel = suggestion -# Run `vale sync` to include packages: https://vale.sh/hub/google/ -Packages = Google +# To update writing-rules package: +# 1. Go on material-ui repo on the docs folder +# 2. Update/create YAML files +# 3. run `pnpm docs:zipRules` to generate the zip files. +# 4. You can test locally by replacing the url by the file path of the generated zip +Packages = Google, https://github.com/mui/material-ui/raw/master/docs/writing-rules.zip [*.md] # Ignore code injection which start with {{... BlockIgnores = {{.* # Custom syle -# BasedOnStyles = Blog +BasedOnStyles = writing-rules + -Blog.ComposedWords = YES -Blog.NamingConventions = YES -Blog.Typos = YES # Google: Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'. From 781f70757d7100dc95b3dc3a391c8cfdf65f57f6 Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Thu, 22 Feb 2024 02:52:31 -0800 Subject: [PATCH 05/13] Update .gitignore Co-authored-by: Jan Potoms <2109932+Janpot@users.noreply.github.com> Signed-off-by: Bharat Kashyap --- .gitignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 92acc846d55..6b77c7c0b30 100644 --- a/.gitignore +++ b/.gitignore @@ -62,4 +62,4 @@ test-results /test/regressions/screenshots/** # vale downloaded config -.github/styles/ \ No newline at end of file +.github/styles/ From 6f46f5d2ed66ac61686a61e7db67dae7c7514807 Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Thu, 22 Feb 2024 02:52:43 -0800 Subject: [PATCH 06/13] Update .gitignore Co-authored-by: Jan Potoms <2109932+Janpot@users.noreply.github.com> Signed-off-by: Bharat Kashyap --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index 6b77c7c0b30..8ce36aaa07c 100644 --- a/.gitignore +++ b/.gitignore @@ -61,5 +61,4 @@ test-results /test/regressions/screenshots/** -# vale downloaded config .github/styles/ From 19e35f4d99e91a9d35d1453989268fb23e4fb77c Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Thu, 22 Feb 2024 02:52:55 -0800 Subject: [PATCH 07/13] Update .vale.ini Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Signed-off-by: Bharat Kashyap --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 0fc2d9bb478..b35fe040f08 100644 --- a/.vale.ini +++ b/.vale.ini @@ -3,7 +3,7 @@ StylesPath = .github/styles MinAlertLevel = suggestion # To update writing-rules package: -# 1. Go on material-ui repo on the docs folder +# 1. Go to the docs folder in the material-ui repo # 2. Update/create YAML files # 3. run `pnpm docs:zipRules` to generate the zip files. # 4. You can test locally by replacing the url by the file path of the generated zip From 0cc81663f910f2cf890effbba349bac6ec1845b4 Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Thu, 22 Feb 2024 02:53:02 -0800 Subject: [PATCH 08/13] Update .vale.ini Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Signed-off-by: Bharat Kashyap --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index b35fe040f08..0aa2c0a271d 100644 --- a/.vale.ini +++ b/.vale.ini @@ -6,7 +6,7 @@ MinAlertLevel = suggestion # 1. Go to the docs folder in the material-ui repo # 2. Update/create YAML files # 3. run `pnpm docs:zipRules` to generate the zip files. -# 4. You can test locally by replacing the url by the file path of the generated zip +# 4. You can test locally by replacing the url with the file path of the generated zip Packages = Google, https://github.com/mui/material-ui/raw/master/docs/writing-rules.zip [*.md] From 3f39e44ab09aace14a94919b56d7f1d593ea50c3 Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Thu, 22 Feb 2024 02:53:08 -0800 Subject: [PATCH 09/13] Update .vale.ini Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Signed-off-by: Bharat Kashyap --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 0aa2c0a271d..571bb08437d 100644 --- a/.vale.ini +++ b/.vale.ini @@ -5,7 +5,7 @@ MinAlertLevel = suggestion # To update writing-rules package: # 1. Go to the docs folder in the material-ui repo # 2. Update/create YAML files -# 3. run `pnpm docs:zipRules` to generate the zip files. +# 3. Run `pnpm docs:zipRules` to generate the zip files # 4. You can test locally by replacing the url with the file path of the generated zip Packages = Google, https://github.com/mui/material-ui/raw/master/docs/writing-rules.zip From f2d94bc33371f2d8866d1b520793fd21b12ffef2 Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Thu, 22 Feb 2024 02:53:14 -0800 Subject: [PATCH 10/13] Update .vale.ini Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Signed-off-by: Bharat Kashyap --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 571bb08437d..05d99894d83 100644 --- a/.vale.ini +++ b/.vale.ini @@ -10,7 +10,7 @@ MinAlertLevel = suggestion Packages = Google, https://github.com/mui/material-ui/raw/master/docs/writing-rules.zip [*.md] -# Ignore code injection which start with {{... +# Ignore code injections that start with {{... BlockIgnores = {{.* # Custom syle From 0bc0f2df9958303264c336e74ec9cb0a523076e3 Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Thu, 22 Feb 2024 02:53:28 -0800 Subject: [PATCH 11/13] Update .vale.ini Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Signed-off-by: Bharat Kashyap --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 05d99894d83..79f1dd7d738 100644 --- a/.vale.ini +++ b/.vale.ini @@ -21,7 +21,7 @@ BasedOnStyles = writing-rules # Google: Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'. Google.GenderBias = YES # Avoid gendered profession -Google.OxfordComma = YES +Google.OxfordComma = YES # Add a comma before the final item in a series Google.Quotes = YES # Commas and periods go inside quotation marks. Google.Spelling = YES #In general, use American spelling (word ending with 'nised' or 'logue') Google.We = YES # Try to avoid using first-person plural From 5539e922c6fd0006d3c89c9873c7537b986c040a Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Thu, 22 Feb 2024 02:53:33 -0800 Subject: [PATCH 12/13] Update .vale.ini Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Signed-off-by: Bharat Kashyap --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 79f1dd7d738..e312a724ddf 100644 --- a/.vale.ini +++ b/.vale.ini @@ -22,7 +22,7 @@ BasedOnStyles = writing-rules Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'. Google.GenderBias = YES # Avoid gendered profession Google.OxfordComma = YES # Add a comma before the final item in a series -Google.Quotes = YES # Commas and periods go inside quotation marks. +Google.Quotes = YES # Commas and periods go inside quotation marks Google.Spelling = YES #In general, use American spelling (word ending with 'nised' or 'logue') Google.We = YES # Try to avoid using first-person plural Google.Latin = YES # Try to avoid latin expressions e.g. and i.e. From a187dd4909c5584a335653846891d5265c32c326 Mon Sep 17 00:00:00 2001 From: Bharat Kashyap Date: Thu, 22 Feb 2024 02:53:39 -0800 Subject: [PATCH 13/13] Update .vale.ini Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Signed-off-by: Bharat Kashyap --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index e312a724ddf..f1ecf05d405 100644 --- a/.vale.ini +++ b/.vale.ini @@ -23,7 +23,7 @@ Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'. Google.GenderBias = YES # Avoid gendered profession Google.OxfordComma = YES # Add a comma before the final item in a series Google.Quotes = YES # Commas and periods go inside quotation marks -Google.Spelling = YES #In general, use American spelling (word ending with 'nised' or 'logue') +Google.Spelling = YES # In general, use American spelling (word ending with 'nised' or 'logue') Google.We = YES # Try to avoid using first-person plural Google.Latin = YES # Try to avoid latin expressions e.g. and i.e.