Guidelines

Submitting Issues

  • Check the project's existing issues to see if your issue has already been reported.

  • Include a clear and concise description of the problem.

  • Provide any relevant details such as error messages, steps to reproduce the problem, and any relevant system information.

Submitting Pull Requests

  • Create a new branch from the master branch and make your changes on that branch.

  • Follow the project's style guidelines (if applicable).

  • Add tests to cover your changes (if applicable).

  • Ensure that the entire test suite passes.

  • Update the documentation if necessary.

  • Use a clear and concise commit message that describes the change.

  • Make sure that your code is properly formatted.

  • Ensure that your code is free of linting errors.

Code Review

  • Your pull request may be reviewed by one or more maintainers.

  • Maintainers will review your code and offer feedback.

  • Make any requested changes and push them to your branch.

  • The pull request will be merged once all checks have passed and the code has been reviewed.

Last updated