Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (28 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

46 lines (28 loc) · 1.67 KB

Please fork, branch and pull-request any changes you'd like to make.

Contributor Dev Machine Setup

  1. Clone or Fork this Repository

    git clone https://github.com/azure/iotedgedev.git

  2. Rename .env.tmp in the root of the repo to .env and set the IOTHUB_CONNECTION_STRING and DEVICE_CONNECTION_STRING values to settings from your IoT Hub and Edge Device. To set these values you could run iotedgedev azure in the root of the repo.

  3. Install Microsoft Visual C++ Build Tools

  4. Run npm install from the root directory to install the required npm packages for iothub-explorer calls.

  5. Install OpenSSL 1.1.0g

  6. Make sure both Python 2.7 and Python 3.6 are installed

  7. Install dependencies

    Run the following command to install all the dependencies needed to build iotedgedev and run the tests.

    pip install -r requirements_dev.txt

  8. Editable Mode

    Run the following command from the root of the IoT Edge Dev Tool Solution to see changes to iotedgedev commands as you change code.

    pip install -e .

VS Code Debugging

VS Code Debugging works only with Python 3.6 VS Code Python Environments for now. Make sure that your VS Code Python Environment is pointing to Python 3.6

Set your CLI arguments in launch.json and hit F5

Run Tests

Run the following command to run tests.

tox