3.9 KiB
Contributing
We're always looking for your help to improve the product (bug fixes, new features, documentation, etc).
Coding conventions and standards
Testing and Code Coverage
In the test folder, run pip install -r requirements-test.txt to install test dependencies.
Unit testing
There should be unit tests that cover the core functionality of the product, expected edge cases, and expected errors. Code coverage from these tests should aim at maintaining over 80% coverage.
All changes should be covered by new or existing unit tests.
Style
Test the behavior, instead of the implementation. To make what a test is testing clear, the test methods should be named following the pattern test_<method or function name>_<expected behavior>_[when_<condition>].
e.g. test_method_x_raises_error_when_dims_is_not_a_sequence
Linting
Ensure that the correct develop packages are installed by pip install -r requirements-dev.txt.
This project uses lintrunner for linting. It provides a consistent linting experience locally and in CI. You can initialize with
lintrunner init
This will install lintrunner on your system and download all the necessary
dependencies to run linters locally.
If you want to see what lintrunner init will install, run
lintrunner init --dry-run.
To lint local changes:
lintrunner
To format files and apply suggestions:
lintrunner -a
To lint all files:
lintrunner --all-files
To show help text:
lintrunner -h
To read more about lintrunner, see wiki.
To update an existing linting rule or create a new one, modify .lintrunner.toml or create a
new adapter following examples in https://github.com/justinchuby/lintrunner-adapters.
Python Code Style
Follow the Black formatter's coding style when possible. A maximum line length of 120 characters is allowed.
Please adhere to the PEP8 Style Guide. We use Google's python style guide as the style guide which is an extension to PEP8.
Auto-formatting is done with black and isort. The tools are configured in pyproject.toml. From the root of the repository, you can run
lintrunner f --all-files
to format Python 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.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
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.
Report a security issue
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.