Contributing

The latest changes are always in master branch, so please make your Pull Request against that branch.

💻 Workflow

• Create a github fork.
• On your fork, create a branch make the changes, commit and push.
• Create a pull-request.

🧾 Checklist

→ If Applicable

• tests should be included as a part of your PR
  • make test or pnpm test to run them.
• a changeset should be provided
  • make cs or pnpm cs to run changeset to request a version bump.
• documentation should be updated, please provide the corresponding documentation as well and make it part of the Pull Request

✉️ Git Message Format

This repo adheres to the Conventional Commits (opens in a new tab) specification. Commit messages are enforced through commitlint (opens in a new tab) and a husky (opens in a new tab) commit-msg hook (opens in a new tab).

This leads to more readable messages that are easy to follow when looking through the project history and also allows to generate changelogs automatically.

Check out more information about the commitlint and other linters in the linting section.

→ Allowed prefixes

• feat — A new feature
• fix — A bug fix
• perf — A code change that improves performance
• docs — Documentation only changes
• style — Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)
• deps — Changes to the package.json or package-lock.json
• refactor — A code change that neither fixes a bug nor adds a feature
• ci — Changes to our CI configuration files and scripts
• test — Adding missing tests or correcting existing tests
• revert — Reverting a previous commit
• build — Changes that affect the build system or external dependencies (example scopes: pnpm, renovate, github actions)
• chore — Other changes that don't modify src or test files
• translation — Changes to the translation files
• security — A code change that fixes a security issue

📋 Coding Rules

Each repository has its own set of coding rules and formatters to automatically enforce them when running tests or committing changes. Check out linting section for more information.

🔓 Security Vulnerabilities

If you discover a security vulnerability within this package, please send an e-mail to WayOfDev via the@wayof.dev. All security vulnerabilities will be promptly addressed.

🤝 Code of Conduct

We are using the Contributor Covenant (opens in a new tab) as our Code of Conduct, to keep discussion open and inclusive. Please, take a moment to read and follow our Code of Conduct (opens in a new tab).