mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 01:15:03 +03:00
Miranda LimonczenkoandMiranda Limonczenko
dcf02db5c7
Closes [DOCS-1036](https://linear.app/supabase/issue/DOCS-1036/add-docs-lint-rule-for-copywriting-style-gaps) ## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? This change expands upon the "us this, not that" style rules and applies them to our linting. ## What is the current behavior? Our current behavior does far fewer checks. ## What is the new behavior? The new behavior spots the following: - Suggesting swapping Latin phrases for common English - Remove formal words for simpler words - Removes marketing language - And more (see code diff) ## Additional context For more information about general style rules, see the style guide: https://supabase.com/design-system/docs/copywriting <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Refined contribution guidelines with clearer style guidance for filler words, terminology (including “Backend” hyphenation), abbreviation usage, and updated wording examples. * Updated the foundations quickstart wording to “Utilize shadcn/ui” under setup guidance. * **Chores** * Expanded MDX linting guidance to flag filler/marketing language, vague verbs, formal corporate phrasing, apologies, human-language punctuation variants, and certain Latin phrases. * Adjusted related lint preferences and downgraded several checks to **WARNING** for a less disruptive experience. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Miranda Limonczenko <miranda@supabase.io>
37 lines
493 B
TOML
37 lines
493 B
TOML
description = "Prefer '%r' to '%s'."
|
|
level = "WARNING"
|
|
words = [
|
|
[
|
|
"PostgreSQL",
|
|
"Postgres",
|
|
],
|
|
[
|
|
"concurrent clients",
|
|
"concurrent connections",
|
|
],
|
|
[
|
|
"utilize",
|
|
"use",
|
|
],
|
|
[
|
|
"utilise",
|
|
"use",
|
|
],
|
|
[
|
|
"utilizes",
|
|
"uses",
|
|
],
|
|
[
|
|
"utilises",
|
|
"uses",
|
|
],
|
|
[
|
|
"utilizing",
|
|
"using",
|
|
],
|
|
[
|
|
"utilising",
|
|
"using",
|
|
],
|
|
]
|