CONTRIBUTING.md

Contributing

First off, thanks for taking the time to contribute. 👍

This guide uses Docusaurus 2 for building the guide itself, and pre-commit for various formatting/cleanup tasks - running content through prettier, formatting Python codeblocks and samples, etc.

To get started with contributing to this guide, follow these steps:

1. cd guide as this is our docusaurus directory.
2. Install dependencies: npm install.
   • Note: Node version 16.14 or higher is required for Docusaurus 2.
3. Build using Docusaurus.
   • To build the documentation once, use npm run build and open build/index.html in your browser
   • Alternatively, if you want to see your changes to the content in real-time, use npm run start to start an autoreloading server on localhost.
4. Run pre-commit.
   • If you want to install the pre-commit hooks to automatically run before every commit, use pre-commit install
   • Otherwise, use pre-commit run --all-files to run all checks once.