Skip to main content

Contributing

We welcome contributions to the project! Whether you're fixing bugs, suggesting new features, or enhancing the documentation, your help is always appreciated.

How to Contribute​

If you find a bug, have an idea for a new feature, or want to improve the documentation, feel free to open an issue or submit a pull request on GitHub.

Before You Start​

To ensure a smooth contribution process, please follow these steps:

  1. Fork the Repository: Start by forking the repository to your GitHub account.
  2. Create a New Branch: Create a branch for your changes. Avoid making changes directly to the main branch.
  3. Make Your Changes: Implement your changes and ensure they follow the project's coding standards.
  4. Test Your Changes: Run tests and ensure everything works as expected. If applicable, add new tests for any new features or bug fixes.
  5. Update Documentation: If your changes involve new functionality, ensure that the documentation is updated accordingly. For documentation updates, check the project's documentation repository.
  6. Submit a Pull Request: Once you've made your changes, submit a pull request to the main repository. Be sure to provide a clear description of the changes you've made.

Code of Conduct​

By participating in this project, you agree to abide by the project's Code of Conduct. We expect all contributors to be respectful and considerate toward each other. Please report any issues with behavior to the repository maintainers.

Additional Notes​

  • Testing: Ensure your changes are well-tested. We value reliable and thoroughly tested code.
  • Documentation: We aim for clear, concise, and up-to-date documentation. Please make sure your contributions reflect this standard.

Thank you for helping improve this project!