Contributing to Legal Chatbot LLM

Thank you for considering contributing to the Legal Chatbot LLM project! Your contributions are highly valued and appreciated. To maintain a smooth and collaborative development process, please adhere to the following guidelines:

How to Contribute

Fork the Repository: Fork the project on GitHub and create your own copy.
Create a Branch: Create a new branch for your changes using git checkout -b feature/improvement.
Make Changes: Implement your desired changes or improvements.
Commit Changes: Commit your changes with a descriptive message using git commit -am 'Add/Fix feature'.
Push Changes: Push your committed changes to your forked repository using git push origin feature/improvement.
Create a Pull Request: Open a pull request on this repository's main branch.

Code Style and Standards

Follow the coding style guidelines specified in the project. we are using black formatter and flake8 linting
Ensure your code adheres to the established standards and practices.
Write clear and concise commit messages to facilitate the review process.

Reporting Issues

If you encounter any issues or bugs, please feel free to open an issue on the repository. Include detailed information about the problem, steps to reproduce it, and any relevant screenshots or error messages.

Contact

For any questions, suggestions, or discussions, please feel free to open an issue or contact the maintainer Izam Mohammed at [email protected].

Your contributions contribute to the continued improvement and success of the Legal Chatbot LLM project. Thank you for your support!