Thank you for your interest in contributing to our project! We welcome contributions from everyone.
Before you start contributing, please read the following guidelines to ensure a smooth collaboration process.
Please note that this project is governed by our Code of Conduct. We expect all contributors to adhere to its guidelines when participating in this project.
If you encounter any bugs or issues while using our project, please open a new issue on GitHub. Make sure to include detailed steps to reproduce the issue and any relevant information about your environment.
If you have ideas for new features or enhancements, feel free to submit them as feature requests. We appreciate your input and will consider all suggestions.
If you'd like to contribute directly to the codebase, you can submit a pull request (PR) with your changes. Here's how:
- Fork the repository to your GitHub account.
- Create a new branch from the
master
branch for your changes. - Make your desired changes and commit them to your branch.
- Test your changes thoroughly to ensure they work as expected.
- Push your branch to your fork and open a new PR against the
development
branch of the original repository. - Provide a clear description of your changes in the PR, including any relevant context or background information.
Our team will review your PR and provide feedback as needed. Once your changes are approved, they will be merged into the main codebase.
To maintain consistency and readability, please adhere to our coding style and guidelines:
- Follow the conventions used in the existing codebase.
- Write clear and concise code with descriptive comments, summary.
- Test your changes rigorously to ensure they meet the project's requirements.
- Use meaningful and descriptive variable, property, method and class names.
If you have any questions or need assistance with contributing, feel free to reach out to us via email or open an issue.
We appreciate your contributions and look forward to working with you!