CONTRIBUTING.md

Contributing

How to Contribute

Configuring python environment

The project requires python version 3.8+. To set it as default in the environment run the following commands:

python3.8 -m venv env
source ./env/bin/activate

Install required dependencies:

python -m pip install --upgrade pip wheel
pip install -r local-requirements.txt
pip install -e .
python setup.py bdist_wheel

For more details look at the CI configuration.

Regenerating APIs

./scripts/update_api.sh
pre-commit run --all-files

Contributor License Agreement

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.