Skip to content

Add CONTRIBUTING.md and build status badges to README#37

Open
ysdy823 wants to merge 1 commit intodextonai:mainfrom
ysdy823:add-contributing-guide-and-badge
Open

Add CONTRIBUTING.md and build status badges to README#37
ysdy823 wants to merge 1 commit intodextonai:mainfrom
ysdy823:add-contributing-guide-and-badge

Conversation

@ysdy823
Copy link
Copy Markdown

@ysdy823 ysdy823 commented Mar 29, 2026

Summary

  • Add a comprehensive CONTRIBUTING.md with dev environment setup, project architecture overview, coding style guidelines (TypeScript and Rust), testing instructions, PR submission workflow, changeset/versioning process, and documentation update checklist.
  • Add CI build status, npm version, and Apache-2.0 license badges to the top of README.md.

Details

CONTRIBUTING.md covers:

  • Dev environment setup -- prerequisites table (Node 20+, pnpm 9+, Rust stable), step-by-step clone/install/build instructions, and a quick-reference command table.
  • Project architecture -- annotated directory tree explaining the Rust CLI and Node.js daemon runtime paths.
  • Coding style -- Prettier config for TypeScript (semicolons, single quotes, trailing commas, 100-char width), strict tsconfig rules, Rust conventions (kebab-case flags, color module usage), and commit message format.
  • Testing -- how to run and write tests with Vitest, plus a breakdown of all six CI jobs.
  • PR workflow -- branch naming, local checks, changeset creation, and a ready-for-review checklist.
  • Documentation updates -- mirrors the five-location update list from AGENTS.md.

README.md badges link to:

  1. GitHub Actions CI workflow (build status)
  2. npm package version
  3. Apache-2.0 license

Test Plan

  • Verify badge URLs resolve correctly and display status on the PR diff.
  • Confirm all links in CONTRIBUTING.md are valid.
  • Ensure no existing README content was altered beyond the badge insertion.

bounty:8e29b86d-2387-4a5a-bd72-69afaa74c4ad

- Add comprehensive CONTRIBUTING.md covering dev environment setup,
  project architecture, coding style guidelines (TypeScript + Rust),
  testing instructions, PR submission workflow, and changeset process
- Add CI build status, npm version, and license badges to README.md

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
MohsinHashmi-DataInn pushed a commit that referenced this pull request Mar 30, 2026
…ity (vercel-labs#582)

* fix(windows): resolve daemon startup failures and Git Bash compatibility

Three root causes behind 27 open Windows issues:

1. Path::canonicalize() returns \\?\ prefixed paths on Windows that
   Node.js cannot parse, preventing daemon startup. Strip the prefix
   before passing to Node. (fixes vercel-labs#522, vercel-labs#390, vercel-labs#56, #25, #37, vercel-labs#89)

2. Git Bash/MSYS2 translates Unix-style paths and resolves node to
   a shell wrapper script. Use node.exe explicitly and set
   MSYS_NO_PATHCONV/MSYS2_ARG_CONV_EXCL to prevent argument mangling.
   (fixes vercel-labs#148, vercel-labs#108, vercel-labs#171)

3. postinstall fixWindowsShims() hardcoded x64 arch and did not verify
   the native binary exists before rewriting shims. Now detects arch
   dynamically and validates the binary path. (fixes vercel-labs#262)

Also:
- Error messages now show TCP port on Windows instead of Unix socket path
- Windows CI expanded to test full daemon lifecycle (open, snapshot, close)

* fix(windows): strip \\?\ prefix in auth-cli path (fixes vercel-labs#579)

Same canonicalize() issue as the daemon spawn path, but in
run_auth_cli() which passes the script path to Node.js.
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.

1 participant