diff options
| author | DivisionByZero <[email protected]> | 2023-04-26 19:51:30 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-04-26 17:51:30 +0000 |
| commit | 5ad55a58cc23bf0076e7f96ae73ae46f4510990d (patch) | |
| tree | d470b95a4e51b834da6c3cf307804001896fb060 /CONTRIBUTING.md | |
| parent | c2b1408850123ddca6cd5a58df4be76d2c039732 (diff) | |
| download | faker-5ad55a58cc23bf0076e7f96ae73ae46f4510990d.tar.xz faker-5ad55a58cc23bf0076e7f96ae73ae46f4510990d.zip | |
docs: add npm script descriptions to CONTRIBUTING (#2095)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12e7b59c..8aca7a54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,20 @@ If you want to make `Faker` a better, please read the following contribution gui # Important -Please make sure that you run `pnpm run preflight` before making a PR to ensure that everything is working from the start. +Please make sure that you run `pnpm run preflight` before making a PR to ensure that everything is working from the start. +This is a shorthand for running the following scripts in order: + +- `pnpm install` - installs npm packages defined in package.json +- `pnpm run generate:locales` - generates locale files +- `pnpm run generate:api-doc` - generates API documentation +- `pnpm run format` - runs [prettify](https://github.com/prettier/prettier) to format code +- `pnpm run lint` - runs [ESLint](https://github.com/eslint/eslint) to enforce project code standards +- `pnpm run build:clean` - removes artifacts from previous builds +- `pnpm run build:code` - builds the code, both CommonJS and ESM versions +- `pnpm run build:types` - builds the TypeScript type definitions +- `pnpm run test:update-snapshots ` - runs all tests, and updates any snapshots if needed +- `pnpm run ts-check:scripts` - checks that there are no TypeScript errors in script files +- `pnpm run ts-check:tests` - checks that there are no TypeScript errors in test or script files ## Good to know |