CONTRIBUTING.md

Contribution

Feel free to reach out to me if you have ideas!

For concrete changes please use pull requests.

For ideas, hints, or if you just don't have time or resources to do pull requests, create an issue.

1. Contribution
   1. Testing
   2. Linting
   3. Building
   4. Pre-Commit Hooks
   5. Documentation
   6. Deployment
   7. More
      1. Structure and Internal Dependencies

Testing

Using Jest.

• npm test: complete test and coverage
• npm run testch: test only the changed files or tests
• npm run testfail: test only the failed cases
• npx jest -t 'my test': run a single test

Includes jest-extended for more specific matchers.

Linting

npm run lint

Using standard

Building

npm run build

Using esbuild

Pre-Commit Hooks

With husky

Documentation

npm run doc

Using jsDoc, see jsdoc.conf.json

Deployment

Test, lint, build, and generate docs with npm run predeploy.

Create a new version with npm version major|minor|patch (follow semantic versioning!).

Run npm run deploy (will first run predeploy) to also create a tag and commit to GitHub and then publish to npm.

More

Structure and Internal Dependencies

You can see a visual dependency graph here.

In VSCode you can generate such a graph via a plugin.