Skip to content

chore: add Zed editor settings example, clean up configs, and improve dev guides#13457

Merged
DeJeune merged 4 commits intomainfrom
chore/config
Mar 14, 2026
Merged

chore: add Zed editor settings example, clean up configs, and improve dev guides#13457
DeJeune merged 4 commits intomainfrom
chore/config

Conversation

@EurFelux
Copy link
Copy Markdown
Collaborator

@EurFelux EurFelux commented Mar 14, 2026

What this PR does

Before this PR:

  • No Zed editor configuration example existed for contributors using Zed
  • Several config files had inconsistent JSON array formatting
  • biome.jsonc had redundant exclude rules
  • Contributing guides did not reference the development guide
  • development.md (zh) was not translated to Chinese
  • Node.js and pnpm versions were hardcoded in the development guide

After this PR:

  • Added .zed/settings.json.example with Biome formatter, oxc/eslint/biome fixAll, and import organization
  • Cleaned up redundant Biome exclude rules and unified JSON array formatting
  • Added "Setting Up Your Development Environment" section to CONTRIBUTING.md (en/zh) linking to the development guide
  • Added Zed editor setup guide to development.md (en/zh)
  • Translated docs/zh/guides/development.md to Chinese
  • Node.js version now references .node-version; pnpm version references packageManager in package.json
  • VSCode extensions now reference .vscode/extensions.json

Why we need it and why it was done in this way

The following tradeoffs were made:

  • The Zed settings file is provided as an .example rather than a direct .zed/settings.json to avoid overriding individual contributor preferences.
  • Versions reference their source of truth files rather than being hardcoded, so docs stay in sync automatically.

The following alternatives were considered:

  • N/A

Breaking changes

None

Special notes for your reviewer

  • The JSON formatting changes are purely cosmetic — no behavior changes. They align with Biome's default formatting rules.
  • The .zed/settings.json.example includes source.fixAll.eslint and source.fixAll.oxc alongside Biome, matching the project's triple-linter setup.

Checklist

Release note

NONE

EurFelux and others added 3 commits March 14, 2026 15:32
- Add development guide reference to CONTRIBUTING.md (en/zh)
- Add Zed editor setup guide to development docs
- Translate zh/guides/development.md to Chinese
- Reference .node-version for Node.js setup instead of hardcoded version
- Reference package.json packageManager for pnpm setup
- Reference .vscode/extensions.json for recommended extensions

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Signed-off-by: icarus <[email protected]>
@EurFelux EurFelux changed the title chore: add Zed editor settings example and clean up config formatting chore: add Zed editor settings example, clean up configs, and improve dev guides Mar 14, 2026
Copy link
Copy Markdown
Contributor

@cherry-ai-bot cherry-ai-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the config cleanup, the Zed example settings, and the documentation updates. The behavior changes here are limited to contributor tooling/docs, and the formatting edits look cosmetic rather than semantic. I don't see a concrete blocking issue in the current revision. LGTM.

@EurFelux EurFelux requested a review from DeJeune March 14, 2026 07:59
@DeJeune DeJeune merged commit d676b3b into main Mar 14, 2026
9 checks passed
@DeJeune DeJeune deleted the chore/config branch March 14, 2026 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants