Contribution Guide

Thank you for wanting to contribute to this project! 🫶 This is an open source project and all help is welcome, from bug fixes to improvements in the documentation.

How to Contribute

  1. Fork this repository.
  2. Create a branch with a descriptive name: git checkout -b (fix|feat|core|wip|style)/(ISSUE_'issue-id')-....
  3. Make your changes and add tests if necessary.
  4. Open a Pull Request explaining what was done and why.

Code Rules

  • Use a consistent code style (if you have ESLint/Prettier, follow the project configuration
  • Avoid adding code unrelated to the main change in the PR.
  • If you add or modify functionality, update the documentation if necessary.
  • Testing is always welcome where applicable.

Communication

If you have any questions or suggestions, feel free to open a issue on GitHub. We discuss ideas openly before we start working.

Useful Links

Thank you for being part of the community! 💙