developing.md

Developing Project Mu Pip Build

Pre-Requisites

1. Get the code

git clone https://github.com/Microsoft/mu_pip_build.git

2. Install development dependencies

pip install --upgrade -r requirements.txt

3. Uninstall any copy of mu_build

pip uninstall mu_build

4. Install from local source (run command from root of repo)

pip install -e .

Testing

1. Run a Basic Syntax/Lint Check (using flake8) and resolve any issues

flake8 MuBuild

!!! info Newer editors are very helpful in resolving source formatting errors (whitespace, indentation, etc). In VSCode open the py file and use ++alt+shift+f++ to auto format.

2. Run pytest with coverage data collected

pytest -v --junitxml=test.junit.xml --html=pytest_MuBuild_report.html --self-contained-html --cov=MuBuild --cov-report html:cov_html --cov-report xml:cov.xml --cov-config .coveragerc

3. Look at the reports

• pytest_MuBuild_report.html
• cov_html/index.html