Skip to content

docs: README missing instructions for running tests #24

Description

@tomkis

Summary

The README currently only documents how to install dependencies and start the development server, but does not mention how to run the test suite.

Current README

npm install
npm start
open http://localhost:3000

What's missing

The project has a test script defined in package.json that uses Jest, but this is not documented anywhere in the README. Contributors and users have no way of knowing they can run:

npm test

Proposed change

Add a section to the README explaining how to run the tests, for example:

npm test

This would help contributors verify their changes before submitting pull requests and generally improve the developer experience.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions