Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.25 KB

CONTRIBUTION.md

File metadata and controls

46 lines (28 loc) · 1.25 KB

Overview:

MINI uses Prettier and ESLint to keep its code consistently formatted.

Please following the instruction carefully before making a pull request!

Prerequisites 🧱:

Installation 💾:

  1. Fork this repo from GitHub and clone it to your local machine:
git clone https://github.com/<username>/mini-ssg.git
  1. Redirect to the project folder:
cd mini-ssg/
  1. Install MINI:
npm install

Development 🧪:

Prettier:

  • npm run prettier-check runs a check against the format style guide found in prettierrc.json.
  • npm run prettier runs the same check and adds --write option to attempt to fix the style issues.

ESLint:

  • npm run lint [file] | [dir] or npm run eslint [file] | [dir] will run all files against the linting style guide found in .eslintrc.
  • npm run eslint-fix [file] | [dir] will do the same as above and also "fixes" any errors.

Testing ⚗️:

  • npm test [file] will run the test on the specified file.
  • npm run test:watch [file] will also run the test but in watch mode, which automatically re-runs when changes are made.