Skip to content

Commit

Permalink
Merge branch 'Libr-AI:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
ruixing76 authored May 15, 2024
2 parents d4d8228 + 8a4263c commit c0dfdea
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ We welcome contributions and feedback from the community and recommend a few bes
* New features should have appropriate documentation added alongside them.
* Aim for code maintainability, and minimize code copying.
* Minimal test are required before submit a PR, run `script/minimal_test.py` and all test cases are required to be passed.
* Please make sure the code style is checked and aligned:
```bash
pre-commit run --all-files
```

### For Feature Requests

Expand All @@ -37,13 +41,14 @@ Loki uses [black](https://github.com/psf/black) and [flake8](https://pypi.org/pr
```bash
pip install pre-commit
pre-commit install
pre-commit run --all-files
```
## How Can I Get Involved?
There are a number of distinct ways to contribute to Loki:
* Implement new features or fix bugs by submitting a pull request: If you want to use a new model or retriever, or if you have an idea for a new feature, we would love to see your contributions.
* We have our [development plan](https://github.com/Libr-AI/OpenFactVerification/tree/main/docs/development_plan.md) that outlines the roadmap for the project. If you are interested in contributing to any of the tasks, please join our [Discord](https://discord.gg/NRge6RS7) and direct message to @Haonan Li.
* We have our [development plan](https://github.com/Libr-AI/OpenFactVerification/tree/main/docs/development_plan.md) that outlines the roadmap for the project. If you are interested in contributing to any of the tasks, please join our [Discord](https://discord.gg/ssxtFVbDdT) and direct message to @Haonan Li.
We hope you find this project interesting and would like to contribute to it. If you have any questions, please feel free to reach out to us on our [Discord](https://discord.gg/NRge6RS7).
We hope you find this project interesting and would like to contribute to it. If you have any questions, please feel free to reach out to us on our [Discord](https://discord.gg/ssxtFVbDdT).

0 comments on commit c0dfdea

Please sign in to comment.