boltr 0.1.1

Pure-Rust Bolt v5.x wire protocol library
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

# Contributing to BoltR

Thank you for your interest in contributing to BoltR! This document provides guidelines for contributing to the project.

## Getting Started

1. Fork the repository
2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/boltr.git`
3. Create a branch: `git checkout -b your-feature`
4. Make your changes
5. Submit a pull request

## Development Setup

### Prerequisites

- Rust 1.85.0+ (edition 2024)
- `cargo` (comes with Rust)

### Building

```bash
cargo build                               # Debug build
cargo build --release                     # Release build
cargo build --all-features                # Build with all features (TLS, client)
```

### Running Tests

```bash
cargo test                                # Full test suite
cargo test --all-features                 # With all features
cargo test test_name -- --nocapture       # Single test with output
```

### Linting and Formatting

All code must pass clippy and rustfmt before merging:

```bash
cargo fmt --all                           # Format code
cargo fmt --all -- --check                # Check formatting
cargo clippy --all-targets --all-features # Run clippy
```

## Code Style

See [.claude/CODE_STYLE.md](.claude/CODE_STYLE.md) for the full style guide. Key points:

- Use `thiserror` for error types, chain with `#[source]`
- No abbreviations in public APIs (use `Connection` not `Conn`)
- Borrow by default, zero-copy where possible
- All public items must be documented
- `#![forbid(unsafe_code)]` - no unsafe code
- Round-trip tests for all PackStream types

## What to Contribute

### Good First Issues

- Adding missing PackStream round-trip tests
- Improving error messages
- Documentation improvements
- Adding examples

### Areas of Interest

- Bolt protocol version support expansion
- Performance improvements (with benchmarks)
- Additional authentication mechanisms
- Client library enhancements

## Pull Request Process

1. Ensure your code compiles with no warnings (`cargo clippy`)
2. Ensure all tests pass (`cargo test --all-features`)
3. Ensure code is formatted (`cargo fmt --all -- --check`)
4. Write tests for new functionality
5. Update documentation if you change public APIs
6. Keep commits focused and well-described

## Commit Messages

- Use the imperative mood ("Add feature" not "Added feature")
- Keep the first line under 72 characters
- Reference issues where applicable

## Architecture

See [.claude/ARCHITECTURE.md](.claude/ARCHITECTURE.md) for an overview of the codebase structure, protocol layers, and design decisions.

## License

By contributing, you agree that your contributions will be licensed under the same dual license as the project: MIT OR Apache-2.0.