forked from p04798526/LLaMA-Factory-Mirror
22 lines
1.1 KiB
Markdown
22 lines
1.1 KiB
Markdown
|
# Contributing to LLaMA Factory
|
||
|
|
|
||
|
|
Everyone is welcome to contribute, and we value everybody's contribution. Code contributions are not the only way to help the community. Answering questions, helping others, and improving the documentation are also immensely valuable.
|
||
|
|
|
||
|
|
It also helps us if you spread the word! Reference the library in blog posts about the awesome projects it made possible, shout out on Twitter every time it has helped you, or simply ⭐️ the repository to say thank you.
|
||
|
|
|
||
|
|
However you choose to contribute, please be mindful and respect our [code of conduct](CODE_OF_CONDUCT.md).
|
||
|
|
|
||
|
|
**This guide was heavily inspired by [transformers guide to contributing](https://github.com/huggingface/transformers/blob/main/CONTRIBUTING.md).**
|
||
|
|
|
||
|
|
## Ways to contribute
|
||
|
|
|
||
|
|
There are several ways you can contribute to LLaMA Factory:
|
||
|
|
|
||
|
|
* Fix outstanding issues with the existing code.
|
||
|
|
* Submit issues related to bugs or desired new features.
|
||
|
|
* Contribute to the examples or to the documentation.
|
||
|
|
|
||
|
|
### Style guide
|
||
|
|
|
||
|
|
LLaMA Factory follows the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html), check it for details.
|