CONTRIBUTING.md

Contribution guide

Build

Please check INSTALLATION.md to build SecretFlow from source.

Test

If you need to run all tests,

bash run_pytest.sh

If you would like to run a single test, e.g. tests/device/test_spu.py,

bash run_pytest.sh test_spu.py

Coding Style

We stick to Google Style.

Formatter

We prefer black as our code formatter. For various editor users, please refer to editor integration. Pass -S, --skip-string-normalization to black to avoid string quotes or prefixes normalization.

Imports formatting

black won't format your imports. You can do this manually or by IDE, e.g. VSCode. The format of imports refers to Imports formatting

Git commit message style

We stick to Angular Style.