Skip to content

docs: correct the contributor command descriptions - #534

Open
wufangyong973 wants to merge 1 commit into
electrohyun:mainfrom
wufangyong973:docs/contributor-command-descriptions
Open

wufangyong973 wants to merge 1 commit into
electrohyun:mainfrom
wufangyong973:docs/contributor-command-descriptions

Conversation

@wufangyong973

Copy link
Copy Markdown
Contributor

#523

The command tables in CONTRIBUTING.md and CONTRIBUTING.ko.md described pnpm typecheck as producing no output and pnpm lint as checking documentation style. Neither is accurate:

  • typecheck actually runs tsup (the package build) plus tsc across the workspace, so it does build packages.
  • lint is eslint . over TypeScript files only (the ESLint config's files is **/*.{ts,mts,cts}), not a documentation style check.

Restated the two rows in both guides as "Build packages and check types" / "Lint TypeScript source files" (and the equivalent Korean wording). The commands themselves are unchanged and the table alignment is preserved.

Closes #523.

@vercel

vercel Bot commented Oct 1, 2026

Copy link
Copy Markdown

@wufangyong973 is attempting to deploy a commit to the electrohyun's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: Repository: electrohyun/smocket/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 64884c07-d1b5-4753-8d8d-95c326b749f7

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

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

@github-actions github-actions Bot added documentation Improvements or additions to documentation 📏 xs Pull request changes fewer than 10 lines good first issue Good for newcomers labels Oct 1, 2026
@vercel

vercel Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
smocket Ready Ready Preview Oct 1, 2026 7:28am UTC

@electrohyun

Copy link
Copy Markdown
Owner

@wufangyong973 Thanks for the contribution! The changes look good.

Could you run pnpm format and push the formatting changes? The updated table in CONTRIBUTING.ko.md needs a small formatting adjustment.

@wufangyong973
wufangyong973 force-pushed the docs/contributor-command-descriptions branch from 4f8b10c to 4970904 Compare October 12, 2026 02:24

This branch was successfully deployed

1 active (outdated) deployment
Preview — 484d8e94 Deployed Oct 1, 2026 by vercel[bot]
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 good first issue Good for newcomers 📏 xs Pull request changes fewer than 10 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: correct the contributor command descriptions

2 participants