Repository Guidelines

Project Structure & Module Organization

transforms/

- LLVM pass module (

src/HelloWorld.cc

include/

CMakeLists.txt

```
test/
```
- sample programs compiled to LLVM IR to exercise the pass.
```
build/
```
- out-of-source build artifacts (created by CMake).
```
run.sh
```
- helper script to build and run the pass end-to-end.

Build, Test, and Development Commands

Configure and build:

cmake -S transforms -B build -DCMAKE_BUILD_TYPE=Release

```
cmake --build build -j
```

If CMake cannot find LLVM: set

LLVM_DIR

(e.g.,

-DLLVM_DIR=$(llvm-config --cmakedir)

Quick demo:
```
bash ./run.sh
```
(builds plugin, compiles
```
test/TestProgram.cc
```
, runs
```
-hlw
```
).

Run pass on IR manually:

clang++ -S -emit-llvm test/TestProgram.cc -o test/TestProgram.ll

opt -load build/LLVMHLWPass.so -hlw -S test/TestProgram.ll -o test/TestProgram_hlw.ll

Inspect or run:

clang++ test/TestProgram_hlw.ll -o a.out && ./a.out

Coding Style & Naming Conventions

C++17, LLVM style: 2-space indentation, no tabs; keep functions short and self-contained.
Names: types
```
UpperCamelCase
```
; functions/vars
```
lowerCamelCase
```
; macros
```
ALL_CAPS
```
.
Includes: prefer
```
<llvm/...>
```
; group and sort; avoid
```
using namespace
```
in headers.
Source files end with
```
.cc
```
; headers (if added) go under
```
include/
```
.

Testing Guidelines

No formal framework; add minimal C/C++ programs under
```
test/
```
(e.g.,
```
test/Loops.cc
```
).

Verify by diffing IR before/after:

opt ... -S in.ll -o out.ll && diff -u in.ll out.ll

Cover: functions with/without loops, calls, globals, and edge cases relevant to the pass.

Commit & Pull Request Guidelines

Commits: imperative mood, concise subject (<= 72 chars), optional scope:
```
pass: print function names
```
.
PRs: include motivation, summary of changes, build/run commands used, and before/after IR or behavior.
Keep diffs focused; ensure
```
run.sh
```
succeeds locally before requesting review.

Configuration Tips

Pin an LLVM toolchain locally; set
```
LLVM_DIR
```
to the correct CMake package path.
Use an out-of-tree build (
```
build/
```
) and do not commit generated artifacts.

Build, Test, and Development Commands

Configure and build:

cmake -S transforms -B build -DCMAKE_BUILD_TYPE=Release

```
cmake --build build -j
```

If CMake cannot find LLVM: set

LLVM_DIR

(e.g.,

-DLLVM_DIR=$(llvm-config --cmakedir)

Quick demo:

bash ./run.sh

(builds plugin, compiles

test/TestProgram.cc

, runs

-hlw

Run pass on IR manually:

clang++ -S -emit-llvm test/TestProgram.cc -o test/TestProgram.ll

opt -load build/LLVMHLWPass.so -hlw -S test/TestProgram.ll -o test/TestProgram_hlw.ll

Inspect or run:

clang++ test/TestProgram_hlw.ll -o a.out && ./a.out

Coding Style & Naming Conventions

C++17, LLVM style: 2-space indentation, no tabs; keep functions short and self-contained.

Names: types

UpperCamelCase

; functions/vars

lowerCamelCase

; macros

ALL_CAPS

Includes: prefer

<llvm/...>

; group and sort; avoid

using namespace

in headers.

Source files end with

.cc

; headers (if added) go under

include/

Repository Guidelines

Repository Guidelines

Project Structure & Module Organization

Build, Test, and Development Commands

Coding Style & Naming Conventions

Testing Guidelines

Commit & Pull Request Guidelines

Configuration Tips

Related Skills

Markdown Converter

Nano Banana Pro

1password

Repository Guidelines

Project Structure & Module Organization

Build, Test, and Development Commands

Coding Style & Naming Conventions

Testing Guidelines

Commit & Pull Request Guidelines

Configuration Tips