Skip to content

docs: correct the contributor command descriptions - #544

Closed
Revan0809 wants to merge 1 commit into
electrohyun:mainfrom
Revan0809:docs/correct-contributor-command-descriptions
Closed

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

Conversation

@Revan0809

Copy link
Copy Markdown
Contributor

Summary

The command tables in CONTRIBUTING.md and CONTRIBUTING.ko.md said pnpm typecheck "produces no output," but it also builds packages (tsup && tsc --noEmit && ... && pnpm --filter smocket-client build && ...). They also described pnpm lint as checking "documentation style," but the ESLint config (eslint.config.*) only targets **/*.{ts,mts,cts}.

  • pnpm typecheck → "Build packages and check types" (English) / "패키지 빌드 및 타입 검사" (Korean)
  • pnpm lint → "Lint TypeScript source files" (English) / "TypeScript 소스 파일 린트" (Korean)

The commands themselves are unchanged.

Fixes #523

Test plan

  • Verified pnpm typecheck's actual definition in package.json builds packages (not just type-checks)
  • Verified eslint.config.* only targets .ts/.mts/.cts files
  • pnpm format — reformatted CONTRIBUTING.ko.md's table column widths to match the new text (confirmed via diff that only the two edited rows' wording changed)

🤖 Generated with Claude Code

@Revan0809
Revan0809 requested a review from electrohyun as a code owner October 1, 2026 12:49
@vercel

vercel Bot commented Oct 1, 2026

Copy link
Copy Markdown

@Revan0809 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: 3a7fa26e-c2a4-4498-ab03-f8e1e04e4cdb

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

Autopilot is currently an internal CodeRabbit preview.


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 📏 s Pull request changes 10–49 lines good first issue Good for newcomers labels Oct 1, 2026
@electrohyun

Copy link
Copy Markdown
Owner

Thank you for the contribution! But, I'd like to keep the remaining good first issues available for other new contributors, so I'll close this PR.

@electrohyun electrohyun closed this Oct 1, 2026
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 📏 s Pull request changes 10–49 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: correct the contributor command descriptions

2 participants