Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (53 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

82 lines (53 loc) · 3.32 KB

Contributing

We're always looking for your help to improve the product (bug fixes, new features, documentation, etc).

Contribute a code change

  • Start by reading the project README to understand the scope and goals of WinML CLI.
  • If your change is non-trivial or introduces new public facing APIs, please use the feature request issue template to discuss it with the team first.
  • For all other changes, you can directly create a pull request (PR) and we'll be happy to take a look.
  • Make sure your PR adheres to the coding conventions and standards below.

Getting started

See the README for prerequisites and installation instructions. Then set up your development environment:

uv sync
uv run pre-commit install

This installs all dependencies and enables pre-commit hooks that automatically check license headers, formatting (Ruff), trailing whitespace, and YAML syntax on every commit.

Runtime check rules

When running WinML CLI from a source tree (uv run winml ...), you need to populate the runtime check rule zips locally. See src/winml/modelkit/analyze/rules/runtime_check_rules/README.md for setup options (GitHub release for external contributors, gim-home script for Microsoft internal, WINMLCLI_RULES_DIR override).

Coding conventions and standards

Python code style

Follow PEP 8 and Google's Python style guide. A maximum line length of 100 characters is enforced.

This project uses the following tools to maintain code quality:

  • Ruff for linting and formatting
  • Mypy for type checking
  • Pytest for testing

Before submitting a pull request, please ensure:

uv run ruff check src/ tests/
uv run ruff format src/ tests/
uv run mypy src/
uv run pytest tests/

Testing

New code must be accompanied by unit tests. Code coverage should aim at maintaining over 80% coverage.

License header

All Python source files must include the MIT license header at the top of the file:

# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
# --------------------------------------------------------------------------

The pre-commit hook configured in Getting started will automatically insert this header on new .py files.

Licensing guidelines

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., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

Code of conduct

See CODE_OF_CONDUCT.md.

Report a security issue

See SECURITY.md.