Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 1.72 KB

Contribution Guidelines

Opening an issue

  • Make sure you're using the latest version, check releases for that.
  • Use the search, maybe there is already an answer.
  • If not found, create an issue, please don't forget to carefully describe it how to reproduce it / pay attention to the issue-template.

Opening a pull request

  • Pull requests only into the master branch.
  • Run pnpm test:ci before opening a pull request to verify that everything is working as expected.
  • Make sure to use conventional commits:
    • docs: - for changes in the documentation.
    • feat([package]): - for new features in the corresponding package.
    • fix([package]): - for bug fixes in the corresponding package.
    • refactor([package]): - for changes in the code that neither fixes a bug nor adds a feature.
    • chore: - for changes in the build process or auxiliary tools.

Working on the library

This project requires pnpm and node.

  1. Fork this repo on GitHub.
  2. Check out the master locally.
  3. From your local repro run pnpm install.
  4. Run pnpm dev to start a dev server for all packages.
  5. Make sure to run pnpm test:ci before opening a pull request, to verify that everything is working as expected.

Working on the docs

This project uses vitepress for the documentation. Use the docs: commands to work on the documentation.