CONTRIBUTING lacks dev setup and the test and lint conventions
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 78/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- eslint, github, javascript, node.js
調査の方向性
まず .github/CONTRIBUTING.md を確認し、次に Issue に記載された規約に沿って README.md、eslint.config.js、tests/unit/pieces.test.js、package.json を確認します。Node 20、インストール方法と3つのスクリプト、CommonJS のエクスポート、テストの設定、ファイルごとの ESLint グローバル変数を文書化し、コミュニティ文書へのリンクを README に追加します。初めてコントリビュートする人が、文書化された手順に従って複数ファイルにまたがる関数を追加し、lint とテストを実行できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Summary
.github/CONTRIBUTING.md is 14 lines and only says to run lint and tests. It leaves out the conventions a contributor needs in order to add or move a function without lint and test failures.
Where
.github/CONTRIBUTING.md:1-14README.md:137-144,README.md:214-217,README.md:304-313eslint.config.js:35-80,tests/unit/pieces.test.js:9-20,package.json:8-10
Details
- How source files become testable. Each
js/*.jsends with a CommonJS footer, and each test rebuilds the globals by hand in dependency order. A new function needs the footer export and the wiring in every suite that loads it. - ESLint globals are listed per file. Calling a function from another file fails lint with
no-undefuntileslint.config.jsis edited. - Node version. CI uses Node 20; there is no
enginesfield,.nvmrcor mention in the docs. -
npm run format. The script exists but is not documented. - Two ESLint configs. Nothing says that
eslint.config.jsis live and.eslintrc.cjsis ignored. - README links. The README does not link CONTRIBUTING, SECURITY or the Code of Conduct, and its tree omits them.
Impact
A first-time contributor who adds a helper in one file and calls it from another gets a lint failure and a ReferenceError in tests, with nothing explaining either.
Suggested fix
Add a "Development" section: Node version, npm install, the three scripts, the export-footer and test-wiring pattern, and the per-file globals rule. Link the community files from the README.
Acceptance criteria
- A new contributor can add a cross-file function using only the documented steps
Getting started
- Relevant files:
.github/CONTRIBUTING.md,README.md - How to run tests:
npm install, thennpm testandnpm run lint - Related docs:
docs/ARCHITECTURE.md,.github/CONTRIBUTING.md
Filed by repo-audit/full-audit at 8a2c86c. Severity: medium. Effort: S. audit-key: documentation|.github/CONTRIBUTING.md|dev-setup
- 主要言語
- JavaScript
- スター
- 4
- フォーク
- 2
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
TMHSDigital/Static_Chess のほかの issue
-
enhancement good first issue severity: medium
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
TMHSDigital/Static_Chess#53 ·
-
documentation good first issue severity: low
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
TMHSDigital/Static_Chess#49 ·
-
documentation good first issue severity: low
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
TMHSDigital/Static_Chess#48 ·
-
documentation good first issue severity: low
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
TMHSDigital/Static_Chess#46 ·
-
documentation good first issue severity: low
難易度 1/5 1〜3時間 初心者へのやさしさ 82/100
TMHSDigital/Static_Chess#45 ·
TMHSDigital/Static_Chess の issue をすべて見る
似ている issue
-
good first issue tests
難易度 1/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
enhancement good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
-
1️⃣ phase/under-investigation flaky/confirmed flaky/needs-decision type/bug
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
growilabs/growi#12246 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
TMHSDigital/Free-Game-Dev-Assets#301 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 79/100