From ef75ce01981f99fbcccb98aa0a5fa5bde7dfe7f5 Mon Sep 17 00:00:00 2001 From: Eoghan Murray Date: Wed, 1 Apr 2026 12:00:00 +0800 Subject: [PATCH] Update styleguilde.md (#1498) * Update styleguilde.md add a note not to say 'just' * Apply formatting changes * Rename styleguilde.md to styleguide.md * Apply formatting changes * Create slimy-eagles-grow.md --------- Co-authored-by: eoghanmurray Co-authored-by: Justin Halsall --- .changeset/slimy-eagles-grow.md | 2 ++ docs/{styleguilde.md => styleguide.md} | 1 + 2 files changed, 3 insertions(+) create mode 100644 .changeset/slimy-eagles-grow.md rename docs/{styleguilde.md => styleguide.md} (94%) diff --git a/.changeset/slimy-eagles-grow.md b/.changeset/slimy-eagles-grow.md new file mode 100644 index 00000000..a845151c --- /dev/null +++ b/.changeset/slimy-eagles-grow.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/docs/styleguilde.md b/docs/styleguide.md similarity index 94% rename from docs/styleguilde.md rename to docs/styleguide.md index db17dcdb..113b5469 100644 --- a/docs/styleguilde.md +++ b/docs/styleguide.md @@ -62,6 +62,7 @@ There are a few style guidelines that aren't covered by the linter rules: ## Picking words - Use "will" over "would" when describing outcomes. +- Don't use words such as "just" or "simply". If it needs to be explained then it is not self evident. ## Documentation translations