Thank you for your interest in contributing to this project! We welcome contributions from the community to help improve and grow this project.
To get started with contributing, please follow these steps:
- Fork the repository.
- Clone the forked repository to your local machine.
- Install the package (using the -e editable flag) and necessary dependencies.
- Make your changes or additions.
- Test your changes to ensure they work as expected.
- Commit your changes with descriptive commit messages.
- Push your changes to your forked repository.
- Submit a pull request to the main repository.
Please follow these guidelines when contributing:
- Be respectful and considerate of others.
- Ensure your code follows the project's coding standards.
- Provide clear and concise documentation for your changes.
- Write meaningful commit messages.
- Test your changes thoroughly before submitting a pull request.
We follow a specific code style in this project. Please adhere to the following guidelines:
- Use consistent indentation (spaces or tabs).
- Follow naming conventions for variables, functions, and classes.
- Keep lines of code within a reasonable length.
- Use comments to explain complex logic or important details.
When submitting a pull request, please provide the following information:
- A clear and descriptive title for your pull request.
- A detailed description of the changes you made.
- Any relevant screenshots or code snippets.
By contributing to this project, you agree that your contributions will be licensed under the LICENSE of this project.
If you have any questions or need further assistance, please don't hesitate to reach out to us.
Happy contributing!