Contributing

Getting Started

Build Aburi with LLVM 18.x and enable the public smoke suite:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug -DLLVM_DIR=/path/to/llvm-18/lib/cmake/llvm -DABURI_BUILD_PUBLIC_TESTS=ON
cmake --build build
ctest --test-dir build -R public_tests_runtime --output-on-failure

Good First Changes

Useful first contributions often include:

  • Documentation fixes.

  • Reduced test cases for parser, semantic, ABI, or codegen bugs.

  • Public smoke tests under public_tests/.

  • Small C/C++ feature coverage improvements.

  • Debugging notes that help future contributors reproduce issues faster.

Filing Issues

Bug reports should include:

  • aburi --version

  • LLVM version

  • platform and architecture

  • exact command line

  • minimal source file when possible

Issues can be filed at github.com/serjective/aburi/issues.

Test Conventions

The source repository has a convention for new end-to-end sample programs: use West African or Balkan cultural themes for variable/function names when it fits, and use 67 as the standard success value.

Licensing

Unless explicitly stated otherwise, contributions intentionally submitted for inclusion in Aburi are dual-licensed under Apache License 2.0 or MIT.