Skip to content

docs: fix incorrect Prettier configuration docs in CONTRIBUTING.md and typos in README#2192

Merged
KarinePistili merged 1 commit into
ruxailab:developfrom
atulXdev:docs/fix-contributing-prettier-docs-and-readme-typos
Jul 15, 2026
Merged

docs: fix incorrect Prettier configuration docs in CONTRIBUTING.md and typos in README#2192
KarinePistili merged 1 commit into
ruxailab:developfrom
atulXdev:docs/fix-contributing-prettier-docs-and-readme-typos

Conversation

@atulXdev

Copy link
Copy Markdown
Contributor

Description

Closes #2190

The project documentation contained outdated and incorrect information about the Prettier configuration, which could mislead new contributors regarding the expected code style.

Changes Made

CONTRIBUTING.md

  • Fixed incorrect statement: Removed the claim "While there's no .prettierrc file..." — a .prettierrc file exists in the project root
  • Updated formatting rules to match the actual .prettierrc configuration:
    • ✅ Single quotes (singleQuote: true)
    • ✅ No semicolons (semi: false)
    • ✅ Trailing commas everywhere (trailingComma: "all")
    • ✅ Parentheses around arrow function parameters (arrowParens: "always")
  • Removed incorrect defaults that were previously documented (double quotes, semicolons enabled, print width, tabs, ES5 trailing commas)

README.md

  • Fixed typo: deply the fuctiondeploy the function

Why This Matters

Accurate contributor documentation helps developers:

  • Follow the correct coding style from the start
  • Avoid unnecessary formatting changes in PRs
  • Reduce failed formatting checks
  • Improve the onboarding experience for new contributors

Testing

  • Verified the .prettierrc file exists and matches the documented configuration
  • No code logic changes — documentation only
Screenshot_162

@github-actions github-actions Bot added Documentation Improvements or additions to documentation low-complexity size/S labels Jul 14, 2026
@sonarqubecloud

Copy link
Copy Markdown

@KarinePistili
KarinePistili merged commit 4be8a9e into ruxailab:develop Jul 15, 2026
10 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation low-complexity size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: fix incorrect Prettier configuration docs in CONTRIBUTING.md and typos in README

2 participants