Contributing Guidelines

Thank you for considering contributing to our project! Here are some guidelines to help you get started:

Reporting Bugs

If you have found a bug, please open an issue on our issue tracker and provide as much detail as possible. This should include:

A clear and concise description of the problem
Steps to reproduce the problem
The expected behavior
The actual behavior
Any relevant error messages or logs

Suggesting Enhancements

If you have an idea for an enhancement or a new feature, please open an issue on our issue tracker and provide as much detail as possible. This should include:

A clear and concise description of the enhancement or feature
Any potential benefits or use cases
Any potential drawbacks or trade-offs

Pull Requests

We welcome contributions via pull requests! Here are some guidelines to help you get started:

Fork the repository and clone it to your local machine.
Create a new branch for your changes: git checkout -b my-new-feature
Install dependencies: pnpm install (pnpm@8.x)
Make your changes and add tests if applicable.
Run the tests: pnpm test
Commit your changes: git commit -am 'Add some feature'
Push your changes to your fork: git push origin my-new-feature
Open a pull request against our main branch.

Pull Request Guidelines

Please make sure your changes are consistent with the project's existing style and conventions.
Please write clear commit messages and include a summary of your changes in the pull request description.
Please make sure all tests pass and add new tests as necessary.
If your change requires documentation, please update the relevant documentation.
Please be patient! We will do our best to review your pull request as soon as possible.

License