Guidelines for submitting issues and pull requests

Submitting Issues

If you encounter a bug, have a feature request, or want to report a problem, please submit an issue on our GitHub repository. When submitting an issue, please include the following information:

  1. A clear and concise title.
  2. A detailed description of the issue or feature request.
  3. Steps to reproduce the issue, if applicable.
  4. Expected behavior and actual behavior.
  5. Additional information, like screenshots or logs, that might help in understanding the issue.

Submitting Pull Requests

We encourage you to submit pull requests with bug fixes, improvements, or new features. To ensure a smooth review process, please follow these guidelines:

  1. Fork the repository and create a new branch for your changes.
  2. Ensure your changes adhere to the code style and conventions of the project.
  3. Add or update tests for your changes and ensure they pass.
  4. Update any relevant documentation to reflect your changes.
  5. Write a detailed description in your pull request, explaining the purpose of your changes and any potential side effects.
  6. Submit your pull request, and wait for a review from the maintainers.