rllvm 0.2.0

A tool to build whole-program LLVM bitcode files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

# Contributing to rllvm

Thanks for your interest in contributing! This guide covers the essentials.

## Development Setup

1. **Install Rust** (stable, edition 2024, MSRV 1.85):
   ```bash
   rustup update stable
   ```

2. **Install LLVM/Clang** (required for building and testing):
   - macOS: `brew install llvm`
   - Linux: `sudo apt install llvm llvm-dev clang libclang-dev`

3. **Build**:
   ```bash
   cargo build --verbose
   ```

## Code Style

CI enforces both `rustfmt` and `clippy`. Please run these before submitting:

```bash
cargo fmt --all                              # Auto-format
cargo fmt --all --check                      # Check formatting (what CI runs)
cargo clippy --all-targets -- -D warnings    # Lint
```

- Follow standard Rust naming conventions.
- Keep changes focused — avoid unrelated reformatting or refactoring in the same PR.

## Running Tests

```bash
cargo test --all --verbose
```

LLVM/Clang must be installed for the test suite to pass. Tests run on both Linux and macOS in CI.

## Pull Request Process

1. **Fork and branch** — create a feature branch from `main`.
2. **Make your changes** — keep commits small and well-described.
3. **Ensure CI passes** — format, clippy, tests, and `cargo audit` all run automatically.
4. **Open a PR against `main`** — describe what you changed and why.
5. **Respond to review feedback** — maintainers may request changes before merging.

## License

By contributing, you agree that your contributions will be licensed under the [Apache-2.0 license](LICENSE).