🎉 Thanks for taking the time to contribute! 🎉
If you would like to report a bug, request a new feature or enhancement, follow this link.
- Fork the repository on GitHub.
- Make the changes to your forked repository.
- When you are finished making changes or improvements, create a pull request from your forked repository to our original repository.
- The core team will review your pull request and provide feedback.
# clone the repo
git clone -b dev https://github.com/laiyer-ai/llm-guard.git
cd llm-guard
# install the repo
pip install -U -r requirements.txt -r requirements-dev.txt
python setup.py install
# download SpaCy model
python -m spacy download en_core_web_trf
Our project uses pytest for testing. Make sure that all tests pass before you submit a pull request.
python -m pytest --exitfirst --verbose --failed-first --cov=.
python -m coverage run -m pytest .
We use black
code style.
You can run pre-commit run --all-files
to run all linters.
If you are adding a new feature or changing the existing functionality, please include corresponding changes in the documentation.
Thank you for making our project better. We appreciate your effort and look forward to your contribution!