Skip to content

docs: CONTRIBUTING does not mention the test suite (npm test) #4

Description

@royalpinto007

The "Development workflow" section of CONTRIBUTING.md tells contributors to run three commands before pushing:

npm run lint        # ESLint
npm run format      # Prettier
npx tsc --noEmit    # TypeScript

The project also has a Vitest suite (npm test, configured in vitest.config.ts, with tests such as lib/utils/urls.test.ts), and it is not mentioned anywhere in CONTRIBUTING or in the pull request checklist. New contributors do not know it exists, so they neither run it nor add tests for the utilities they touch.

What to do

In CONTRIBUTING.md:

  1. Add npm test to the "Development workflow" command block with a short comment, for example # Vitest unit tests.
  2. Add a - [ ] npm test passes line to the "Pull request checklist" section.
  3. Add a short note under "What to contribute" saying that pure functions under lib/utils/ should come with a Vitest test, pointing at lib/utils/urls.test.ts as the example to copy.
  4. Note accurately that the CI workflow (.github/workflows/ci.yml) currently runs lint, type check, format check, and build. Do not claim CI runs the tests unless you also add that step to the workflow. If you want to add it, say so in the PR description so a maintainer can weigh in.

Docs only unless you opt into step 4.

Verify

npm run format
npx prettier --check .

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions