Skip to content

Contributing

We welcome contributions to enhance and improve our project. Whether you're a developer, designer, or a domain expert, you can contribute in various ways. To ensure a smooth and collaborative process, please follow these guidelines when contributing to our project:

  • Fork the repository: Start by forking the project repository to your GitHub account. This will create a copy of the project that you can freely modify.

  • Branching strategy: Create a new branch for your contributions. It's recommended to use a descriptive name that reflects the purpose of your changes or feature.

  • Coding standards: Adhere to our coding standards and best practices. Maintain consistent code formatting, ensure proper documentation, and follow any specific guidelines mentioned in the repository.

  • Committing changes: Make atomic commits that capture logical units of work. Provide clear and concise commit messages that describe the changes made.

  • Pull requests: When you're ready to contribute your changes, submit a pull request from your branch to the main repository's main branch. Include a detailed description of the changes and any relevant context.

  • Issue tracking: If you encounter any issues or have ideas for improvements, feel free to open an issue on our GitHub repository. Provide a clear title, description, and, if possible, steps to reproduce the issue.

  • Code review: We value collaboration and constructive feedback. Be open to code reviews and address any comments or suggestions provided by the project maintainers or other contributors.

    By following these contribution guidelines, we can maintain a high-quality project and foster a vibrant and inclusive community. We appreciate your contributions and look forward to working with you.

    For more information, please refer to our full contribution guide here.

    If you have any questions or need further assistance, please refer to the Support section or contact the project maintainers listed in the Authors section.

Released under the MIT License.