Skip to main content

Development

If you want to develop new feature, please follow below steps to set up development environment.

We suggest you to use Visual Studio Code and install the recommended extensions for this project. You can also develop online with GitHub Codespaces.

Check Environment#

Follow System Requirements.

Set Up#

git clone --recurse-submodules -j8 https://github.com/microsoft/superbenchmarkcd superbenchmark
python3 -m pip install -e .[develop]

Lint and Test#

Format code using yapf.

python3 setup.py format

Check code style with mypy and flake8

python3 setup.py lint

Run unit tests.

python3 setup.py test

Submit a Pull Request#

Please install pre-commit before git commit to run all pre-checks.

pre-commit install --install-hooks

Open a pull request to main branch on GitHub.