Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.76 KB
Raw

Contribution guidelines

You can contribute to this project by:

  • creating issues to report a bug, request a feature or ask a question;
  • opening pull requests with improvements to the documentation or the code;
  • participating in discussions.

The following websites can provide tips and guidance on how to contribute to open source projects:

Please do your best to communicate the necessary context so your contribution can be easily understood by other persons, and don’t be afraid if you struggle with English or if you are not sure about what you are doing.

Bug reports

When reporting a bug, here are the informations you can provide to help other persons to help you:

  • version of the library that you are using;
  • technical context (like Node or browser version);
  • a clear description of the issue you are facing, with the less possible code required to understand or reproduce the issue.

Pull requests

Before submitting code, the changes you bring should:

  • have written tests that don’t fail when they are run (pnpm run test)
  • have updated JSDoc comments, updated types (pnpm run types) that are tested (pnpm run test-types);
  • respect the code styles (pnpm run lint-fix) defined using EditorConfig and ESLint.

Tests are using Vitest, and a command for its UI is available (npm run test:ui).