Skip to content

feature: add EditorConfig and VS Code recommendations for consistent DX #628

@devwithjay

Description

@devwithjay

Feature Request 🛍️ - Add EditorConfig and VS Code extension recommendations

Use Case

Contributors may use different editors and personal configurations, which can lead to inconsistent formatting, whitespace issues, and unnecessary diffs in pull requests.

Providing a shared baseline helps keep contributions consistent across editors without enforcing any specific tooling.

Possible Solution

  • Add an .editorconfig file to define basic formatting rules
  • Add .vscode/extensions.json to recommend commonly used extensions such as:
    • EditorConfig support
    • Prettier
    • Tailwind CSS IntelliSense

These files are optional and non-intrusive, and only act as guidance for contributors.

Context

While working on the repository locally, I noticed formatting behavior varied depending on editor setup. Adding EditorConfig and editor recommendations helped reduce formatting-related noise and improved the contributor experience.

Detailed Description

EditorConfig provides editor-agnostic formatting rules that are respected by most modern IDEs, while VS Code extension recommendations help new contributors quickly set up a productive development environment.

This change improves consistency, reduces friction during reviews, and makes onboarding easier, without affecting runtime behavior or existing workflows.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions