renderreport 0.1.0-alpha.2

Data-driven report generation with Typst as embedded render engine — no CLI dependency
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

# Contributing to RenderReport

Thank you for your interest in contributing to RenderReport!

## Development Setup

### Prerequisites

- Rust 1.70 or later
- Git

### Getting Started

```bash
# Clone the repository
git clone https://github.com/casoon/renderreport
cd renderreport

# Build the project
cargo build

# Run tests
cargo test

# Run examples
cargo run --example seo_audit
```

## Project Structure

- `src/` - Core library code
  - `engine/` - Rendering engine
  - `components/` - Standard components
  - `theme/` - Theme and token system
  - `pack/` - Template pack system
  - `render/` - Typst compilation
  - `vfs/` - Virtual filesystem
- `templates/` - Built-in Typst templates
- `packs/` - Bundled template packs
- `examples/` - Usage examples
- `tests/` - Integration tests
- `docs/` - Additional documentation

## Coding Guidelines

### Rust Style

- Follow the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/)
- Run `cargo fmt` before committing
- Run `cargo clippy` and fix warnings
- Add documentation for public APIs
- Write tests for new functionality

### Commit Messages

- Use conventional commits format
- Examples:
  - `feat: add new component type`
  - `fix: correct token rendering`
  - `docs: update API documentation`
  - `test: add tests for theme system`

### Pull Requests

1. Fork the repository
2. Create a feature branch (`git checkout -b feat/my-feature`)
3. Make your changes
4. Add tests
5. Ensure all tests pass (`cargo test`)
6. Commit your changes
7. Push to your fork
8. Create a Pull Request

### Testing

- Write unit tests for new functionality
- Add integration tests for user-facing features
- Ensure all tests pass before submitting a PR
- Aim for >80% code coverage

## Areas for Contribution

### High Priority

- Additional standard components
- More template packs (web-quality, security-audit)
- Performance improvements
- Documentation improvements

### Medium Priority

- HTML output support (experimental)
- Remote pack loading
- Pack validation tools
- Visual regression testing

### Low Priority

- WASM support
- Additional themes
- Preview server for pack development

## Questions?

Open an issue or discussion on GitHub.

## Code of Conduct

Be respectful, professional, and welcoming to all contributors.