Welcome and thank you for your interest in contributing to Guardrails! We appreciate all contributions, big or small, from bug fixes to new features. Before diving in, let's go through some guidelines to make the process smoother for everyone.
Sign in to like and favorite skills
Welcome and thank you for your interest in contributing to Guardrails! We appreciate all contributions, big or small, from bug fixes to new features. Before diving in, let's go through some guidelines to make the process smoother for everyone.
git clone https://github.com/guardrails-ai/guardrails.gitcd guardrailsmake devpre-commit installFollow these steps before committing your changes:
make testmake autoformatmake typedocsmkdocs serveFor convenience, consider installing the pre-commit hooks provided in the repository. These hooks automatically run tests and formatting checks each time you commit, reducing development overhead.
Thank you for your contribution and happy coding!
Docs are served via docusaurus. To serve docs locally, run the following
# install dependencies pip install -e ".[dev]" # install npm dependencies npm i # serve the docs npm run start
then navigate to
localhost:3000