Skip to content

Latest commit

 

History

History
129 lines (82 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

129 lines (82 loc) · 3.02 KB

Contributing to Explainer.js

Thank you for taking your time to contribute! Before filing an issue check preexisting issues to ensure there's no duplication. If you would like to work on an issue, leave a comment. Also you should add tests to you PR(if applicable) to cover gaps in the overall testing system.

Get Started

  1. Clone the repository.

    git clone <repository-url>
    cd <repository-directory>

  2. Install dependencies.

    npm install

  3. Set up your .env file with your API key and base URL.

    API_KEY=your-api-key

Scripts

  1. Run Prettier on the Entire Codebase

    Runs Prettier to format all files in the codebase according to the configured style.

    npm run prettier

  2. Check Prettier Formatting

    Checks if files in the codebase are formatted according to Prettier without making any changes. Useful for verifying formatting compliance.

    npm run prettier:check

  3. Run Prettier on a Specific File

    Formats a single specified file using Prettier. Replace <file-path> with the path to the file you want to format.

    npm run prettier:file <file-path>

  4. Run ESLint on the Entire Codebase

    Runs ESLint to identify any linting errors or warnings across the entire codebase.

    npm run lint

  5. Check ESLint Errors

    Runs ESLint in check mode to list any linting issues without fixing them. This script will display both errors and warnings.

    npm run lint:check

  6. Run ESLint on a Specific File

    Runs ESLint on a single specified file to check for linting issues. Replace <file-path> with the path to the file you want to lint.

    npm run lint:file <file-path>

  7. Run Prettier and Linter in Sequence

    Runs both Prettier and ESLint in sequence on the entire codebase to ensure consistent styling and code quality.

    npm run clean

There is a pre-commit hook that will automatically run prettier and linter on the staged files as well.

Running Tests

  1. Run All Tests

    Runs all Jest tests in the project, including unit and end-to-end tests.

    npm run test

  2. Run Tests in Watch Mode

    Runs tests in watch mode to automatically rerun tests when changes are detected.

    npm run test:watch

  3. Run Tests with Coverage Report

    Runs tests and generates a coverage report.

    npm run coverage

  4. Run a Specific Test

    To run a specific test file, use the following command and replace the TomlChecker with the test file name.

    npm run test TomlChecker
    npm run test:watch TomlChecker
    npm run coverage TomlChecker