Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

65 lines (46 loc) · 1.77 KB
Raw

Guide for contributors

Scala Native Bindgen follows Scala Native's contributing guidelines. Larger contributions should always begin by creating an issue to ensure that it is properly scoped.

Important to note is that all contributors must have signed the Scala CLA.

Developer Workflow

Build the scalaBindgen tool:

mkdir bindgen/target
cd bindgen/target
cmake ..
make

# Alternatively rerun on change
watchman-make -p '*.cpp' '*.h' --run 'make -C bindgen/target'

In another terminal, run the test suite:

cd tests
sbt ~test

To run the same tests as is run by Travis CI use the test.sh script, which will both build the executable and run sbt verify:

./scripts/test.sh

Coding Guidelines

Code should be formatted with ./scripts/scalafmt and ./scripts/clangfmt. Make sure that all of your contributions are properly formatted before suggesting any changes. You can check the formatting using either:

scripts/scalafmt --test
scripts/clangfmt --test

or:

docker-compose run --rm ubuntu-18.04-llvm-6.0 scripts/scalafmt --test
docker-compose run --rm ubuntu-18.04-llvm-6.0 scripts/clangfmt --test

The C++ tool is built on Clang and Libtooling and should respect the conventions of LLVM and Clang tools. The code itself should adhere to the LLVM Coding Standards, specifically:

  • For code generation and error reporting use llvm::outs() and llvm::errs().
  • Use \n instead of std::endl and remember to flush when reporting errors.