This guide outlines how you can contribute.
- Fork the repository and clone it to your local machine.
- Create a new branch for your contribution:
git checkout -b my-contribution- Make your changes, following the coding conventions and best practices.
- Write tests to ensure the correctness of your changes.
- Commit your changes:
git commit -m "Add my contribution"- Push your changes to be reviewed
git push origin my-contribution- Open a pull request from your forked repository to the main project repository.
- Provide a descriptive title and detailed description of your changes in the pull request.
- Be responsive to any feedback or requests for modifications to your contribution.
- Once approved, your contribution will be merged into the main project repository.
Please follow these coding conventions to maintain a consistent and readable codebase:
- Use meaningful variable and function names.
- Write clear and concise comments.
- Follow the established indentation style.
- Use appropriate spacing and line breaks for readability.
- Keep the codebase clean and free from unnecessary or commented-out code.
- Write comprehensive tests for your code.