Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 1.54 KB
Raw

Contributing to the HSE Python Bindings

We welcome your contributions to the HSE Python bindings.

General Information on Contributing

Please review the general information on contributing to the HSE project found in the CONTRIBUTING.md file in the hse repo. It contains important information on contributing to any repo in the HSE project.

Information on Contributing to this Repo

Cloning

You can clone HSE through both HTTPS and SSH protocols.

# HTTPS
git clone https://github.com/hse-project/hse.git
# SSH
git clone git@github.com:hse-project/hse.git

Coding Style

Please format Python source and stub files with black.

Working in the HSE Repository

If you are working on a feature or bug that requires work in both hse and hse-python, then make subprojects/hse a symlink to the hse repository on your system or vice-versa. Then in the event you edit hse, hse-python will see the changes as well and re-build/re-link appropriately.

Testing

After building with hse-python successfully, tests can be ran using the following command:

meson test -C build

The hse-python test suite is intentionally small because all that needs to be tested is that the hse-python calls get translated successfully. If you want to add functional tests for HSE, please send your contributions there.