toon-rust 0.1.2

Token-Oriented Object Notation (TOON) - JSON for LLM prompts at half the tokens. Rust implementation.
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

# Contributing to toon-rust

Thank you for your interest in contributing to `toon-rust`! This document provides guidelines and instructions for contributing.

## Code of Conduct

This project adheres to the [Rust Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct). By participating, you are expected to uphold this code.

## How to Contribute

### Reporting Bugs

1. Check if the bug has already been reported in [Issues](https://github.com/dedsecrattle/toon-rust/issues)
2. If not, create a new issue with:
   - A clear, descriptive title
   - Steps to reproduce the bug
   - Expected vs actual behavior
   - Rust version and OS information
   - Minimal code example if applicable

### Suggesting Enhancements

1. Check existing issues and discussions
2. Open an issue describing:
   - The enhancement and use case
   - Why it would be useful
   - Potential implementation approach (if you have ideas)

### Pull Requests

1. **Fork the repository** and create a feature branch
   ```bash
   git checkout -b feature/your-feature-name
   ```

2. **Make your changes**
   - Follow Rust style guidelines
   - Add tests for new functionality
   - Update documentation as needed

3. **Ensure code quality**
   ```bash
   # Format code
   cargo fmt
   
   # Run clippy
   cargo clippy -- -D warnings
   
   # Run tests
   cargo test
   ```

4. **Commit your changes**
   - Write clear, descriptive commit messages
   - Follow [Conventional Commits](https://www.conventionalcommits.org/) if possible

5. **Push and create a Pull Request**
   - Reference any related issues
   - Describe your changes clearly
   - Ensure CI checks pass

## Development Setup

```bash
# Clone the repository
git clone https://github.com/dedsecrattle/toon-rust.git
cd toon-rust

# Run tests
cargo test

# Run with verbose output
cargo test -- --nocapture

# Check formatting
cargo fmt -- --check

# Run clippy
cargo clippy -- -D warnings

# Build documentation
cargo doc --open
```

## Code Style

- Follow standard Rust formatting (`cargo fmt`)
- Use meaningful variable and function names
- Add documentation comments for public APIs
- Keep functions focused and small
- Handle errors explicitly (avoid `unwrap()` in library code)

## Testing

- Add unit tests for new functionality
- Add integration tests for complex scenarios
- Ensure all tests pass before submitting PR
- Test edge cases and error conditions

## Documentation

- Update `README.md` if adding new features
- Add doc comments for public APIs
- Include usage examples in documentation
- Update `CHANGELOG.md` for user-facing changes

## Review Process

1. All PRs require review before merging
2. Maintainers will review for:
   - Code quality and style
   - Test coverage
   - Documentation completeness
   - Backward compatibility
3. Address review comments promptly
4. Squash commits if requested

## Questions?

Feel free to open an issue with the `question` label or start a discussion!

Thank you for contributing to `toon-rust`! 🎉