Welcome! We appreciate your interest in contributing to Scikit-LLM. Whether you're a developer, designer, writer, or simply passionate about open source, there are several ways you can help improve this project. This document will guide you through the process of contributing to our Python repository.
IMPORTANT: We are currently preparing the transition to v.1.0 which will include major code restructuring. Until then, no new pull requests to the main branch will be approved unless discussed in advance via issues or in Discord !
There are several ways you can contribute to this project:
- Bug Fixes: Help us identify and fix issues in the codebase.
- Feature Implementation: Implement new features and enhancements.
- Documentation: Improve the project's documentation, including code comments and README files.
- Testing: Write and improve test cases to ensure the project's quality and reliability.
- Translations: Provide translations for the project's documentation or user interface.
- Bug Reports and Feature Requests: Submit bug reports or suggest new features and improvements.
Important: before contributing, we recommend that you open an issue to discuss your planned changes. This allows us to align our goals, provide guidance, and potentially find other contributors interested in collaborating on the same feature or bug fix.
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
In order to install all development dependencies, run the following command:
pip install -r requirements-dev.txtTo ensure that you follow the development workflow, please setup the pre-commit hooks:
pre-commit install