forked from BeastByteAI/scikit-llm
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
adf1969
commit 40f31cd
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Contributing to Scikit-LLM | ||
|
||
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. | ||
|
||
## How Can I Contribute? | ||
|
||
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. | ||
|
||
> ### Legal Notice <!-- omit in toc --> | ||
> 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. | ||
## Development dependencies | ||
|
||
In order to install all development dependencies, run the following command: | ||
|
||
```shell | ||
pip install -e ".[dev]" | ||
``` | ||
|
||
To ensure that you follow the development workflow, please setup the pre-commit hooks: | ||
|
||
```shell | ||
pre-commit install | ||
``` |