docs: align contributer guide

[leekeh]

🔗 Linked issue

resolve #2523

🧭 Context

• update git hooks info
• update vscode settings to reduce formatting issues
• starting a connector is no longer an optional step
• update text fixture list

📚 Description

This is my first contribution, and I tried to take some time to enhance some things that stood out. At the same time, I'm new to this project, so let me know if something seems off.

The issue mentions that git hooks were removed, after looking into it they are actually still here, the config just moved to vite plus.

I removed the code coverage part of storybook, it was not defined and in my opinion this should be self-explanatory: if the component is defined in the UI library it should be in storybook (I see there is a ticket to add the missing ones). If some components are more reusable than others, it might be better to organize the components a bit to reflect that.

I also noticed the list of dev commands and project structure was not complete, but I figured you might only want to highlight the most relevant entries. For example, I’m not sure if you want to mention storybook or i18n commands, at least not initially.

Finally, I noticed on my first run that I could not really do much without running a connector. The document mentions only needing it for admin tasks, but I had to add it to be able to search for packages and view package info. Therefore no longer optional. If I did something wrong, lmk.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
npmx.dev	Ready	Preview	Aug 7, 2026 6:15am

2 Skipped Deployments

Project	Deployment	Actions	Updated (UTC)
docs.npmx.dev	Ignored	Preview	Aug 7, 2026 6:15am
npmx-lunaria	Ignored		Aug 7, 2026 6:15am

[github-actions]

Hello! Thank you for opening your first PR to npmx, @leekeh! 🚀

Here’s what will happen next:

1. Our GitHub bots will run to check your changes.
   If they spot any issues you will see some error messages on this PR.
   Don’t hesitate to ask any questions if you’re not sure what these mean!

2. In a few minutes, you’ll be able to see a preview of your changes on Vercel

3. One or more of our maintainers will take a look and may ask you to make changes.
   We try to be responsive, but don’t worry if this takes a few days.

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Updated contributor guidance for prerequisites, mock connector setup, development workflows, formatting, pre-commit checks, fixture examples, Playwright snapshots, and current testing guidance.
• Chores
  • Added recommended VS Code formatter settings for JSON, JSONC, TypeScript, Vue, and YAML files.
  • Improved consistency between editor formatting and the project’s established development standards.

Walkthrough

The changes configure OXC as the VS Code formatter and update CONTRIBUTING.md with current environment, connector, formatting, testing, fixture, hook, and Storybook guidance.

Changes

Contributor workflow

Layer / File(s)	Summary
Development environment and connector setup CONTRIBUTING.md	The guide now uses versions from package.json, documents mock connector setup, clarifies cache bypass scope, and generalises connector guidance.
Formatting and staged-file checks .vscode/settings.json, CONTRIBUTING.md	VS Code uses oxc.oxc-vscode for supported languages. The guide documents OXC formatting and staged-file hook operations.
Test images, fixtures, and connector architecture CONTRIBUTING.md	The Playwright image version is updated, fixture directories are listed, and an obsolete connector tree entry is removed.
Storybook contribution conventions CONTRIBUTING.md	Obsolete coverage guidance is removed. The guide now requires Component Story Format stories.

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Out of Scope Changes check	⚠️ Warning	.vscode/settings.json adds formatter configuration that issue #2523 does not require because the issue is limited to a CONTRIBUTING.md consistency review.	Move the VS Code formatter changes to a separate issue or pull request, unless issue #2523 scope is explicitly expanded.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	The pull request updates CONTRIBUTING.md to reflect the current Git hook workflow and related repository state, satisfying issue #2523.
Title check	✅ Passed	The title clearly identifies the main documentation change and follows a concise conventional commit format, despite a minor spelling error in “contributer”.
Description check	✅ Passed	The description directly explains the documentation and development-setting updates in the changeset.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CONTRIBUTING.md`:
- Line 1239: Correct the typo in the contributor instructions by changing
“commiting” to “committing” in the staged-files guidance.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 61966bab-a555-4705-b543-cab820f14079

📥 Commits

Reviewing files that changed from the base of the PR and between ae1e982 and 947e1a8.

📒 Files selected for processing (2)

• .vscode/settings.json
• CONTRIBUTING.md

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

[github-actions]

Thanks for your first contribution, @leekeh! 💥

We'd love to welcome you to the npmx community. Come and say hi on Discord! And once you've joined, visit npmx.wamellow.com to claim the contributor role.