Skip to main content

Contribution Guidelines

Thank you for considering contributing to our project! Here are some guidelines to follow:

How to Contribute​

  1. Fork the repository.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes: git checkout -b feature-name.
  4. Make your changes and commit them with clear and descriptive messages.
  5. Push your changes to your fork: git push origin feature-name.
  6. Open a pull request from your forked repository to the main repository's main branch.

Reporting Bugs​

  • Check the issue tracker to see if the bug has already been reported.
  • If not, create a new issue and provide detailed information about the bug, including steps to reproduce it and any relevant screenshots or logs.

Requesting Features​

  • Check the issue tracker to see if the feature has already been requested.
  • If not, create a new issue and describe the feature you would like to see, explaining why it would be beneficial.

Code Style​

  • Follow the coding style used in the existing codebase.
  • Ensure your code is well-documented and includes comments where necessary.

Code of Conduct​

  • Be respectful and considerate in your interactions with other contributors.
  • Follow our Code of Conduct.

We appreciate your contributions and look forward to working with you!