Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

65 lines (45 loc) · 1.87 KB

Contributing

Setup

To build OpenDAL Swift binding, the Swift toolchain is required to be installed.

For Ubuntu and CentOS, you may follow the instructions in this documentation to install it. Make sure that swift binary is added to your path:

export PATH=/path/to/swift-toolchain/usr/bin:"${PATH}"

For macOS, you can install Xcode or Xcode command line tools to get your environment all set.

Then you can validate your Swift installation by executing swift --version.

$ swift --version

Swift version 5.8.1 (swift-5.8.1-RELEASE)
Target: x86_64-unknown-linux-gnu

For better development experience, we recommend you to configure your editors to use SourceKit-LSP (the LSP for Swift). Visit SourceKit-LSP repository for more details.

Build

To build the binding package:

$ make

Swift packages are not released via binary artifacts typically. However, you can still build the package locally to check whether there are compilation errors.

To clean the build results:

$ make clean

Test

To build and run the tests:

$ make test

Test Suite 'All tests' started at xxx.
Test Suite 'OpenDALPackageTests.xctest' started at xxx.
Test Suite 'OpenDALTests' started at xxx.
Test Case '-[OpenDALTests.OpenDALTests testSimple]' started.
Test Case '-[OpenDALTests.OpenDALTests testSimple]' passed (xx seconds).
Test Suite 'OpenDALTests' passed at xxx.
         Executed 1 test, with 0 failures (0 unexpected) in xx (xx) seconds
Test Suite 'OpenDALPackageTests.xctest' passed at xxx.
         Executed 1 test, with 0 failures (0 unexpected) in xx (xx) seconds
Test Suite 'All tests' passed at xxx.
         Executed 1 test, with 0 failures (0 unexpected) in xx (xx) seconds