Thank you for your interest in contributing to this project! We appreciate your effort and want to make the process as smooth as possible. Please follow these guidelines to ensure a successful contribution.
- Fork the repository on GitHub.
- Clone your fork to your local machine.
- Create a new branch for your feature or bugfix.
- Make your changes and commit them to your branch.
- Push your branch to your fork on GitHub.
- Open a pull request from your fork to the main repository.
Please adhere to the following coding standards:
- Use consistent indentation (spaces or tabs) throughout the project.
- Follow the naming conventions used in the existing codebase.
- Write clean, readable, and well-documented code.
- Include comments where necessary to explain complex or non-obvious code.
- Write unit tests for your changes, if applicable.
When submitting a pull request, please ensure that:
- Your code compiles and passes all tests.
- Your commit messages are clear and concise.
- Your pull request targets the
mainbranch. - Your branch must be of the format
<user>/feature/<feature-name>or<user>/bugfix/<bugfix-name>.- e.g.
john/feature/add-loggingoryahya/bugfix/fix-logging
- e.g.
- Your pull request includes a description of the changes and any relevant context.
- You have resolved any merge conflicts.
If you encounter any issues or have suggestions for improvements, please open an issue on GitHub. Be sure to include the following information:
- A clear and concise description of the issue or suggestion.
- Steps to reproduce the issue, if applicable.
- Any relevant error messages or logs.
- Your operating system and software versions.
Thank you for your contribution! We look forward to working with you to improve this project.