treelog 0.0.6

A highly customizable, optimized, and modular tree rendering 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
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

# Contributing to TreeLog

Thank you for your interest in contributing to TreeLog! This document provides guidelines and instructions for contributing.

## Code of Conduct

This project adheres to a code of conduct. By participating, you are expected to uphold this code.

## How to Contribute

### Reporting Bugs

Before creating a bug report, please check existing issues to see if the problem has already been reported.

When creating a bug report, please include:
- A clear, descriptive title
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Environment details (Rust version, OS, etc.)
- Any relevant code snippets or examples

### Suggesting Enhancements

Enhancement suggestions are welcome! Please include:
- A clear description of the enhancement
- Use cases and examples
- Any potential implementation considerations

### Pull Requests

1. **Fork the repository** and create your branch from `main`
2. **Make your changes** following the coding standards below
3. **Add tests** for new functionality
4. **Update documentation** as needed
5. **Run tests** to ensure everything passes:
   ```bash
   cargo test --features all
   cargo test --features all --doc
   ```
6. **Commit your changes** with clear, descriptive commit messages
7. **Push to your fork** and open a pull request

## Development Setup

1. Clone the repository:
   ```bash
   git clone https://github.com/muijf/treelog.git
   cd treelog
   ```

2. Build the project:
   ```bash
   cargo build
   ```

3. Run tests:
   ```bash
   cargo test --features all
   ```

4. Run examples:
   ```bash
   cargo run --example basic
   ```

5. **Set up pre-commit hooks** (optional but recommended):
   ```bash
   # Install pre-commit
   pip install pre-commit

   # Install git hooks
   pre-commit install
   ```

   Pre-commit hooks will automatically run code formatting and linting checks before each commit. See [pre-commit.com](https://pre-commit.com/) for more information.

## Coding Standards

### Code Style

- Follow Rust standard formatting (use `cargo fmt`)
- Run `cargo clippy` and fix any warnings
- Keep functions focused and modular
- Add documentation comments for public APIs

### Testing

- Write unit tests for new functionality
- Ensure all tests pass with `cargo test --features all`
- Include doctests in documentation examples
- Test edge cases and error conditions

### Documentation

- Document all public APIs
- Include examples in doc comments
- Update README.md for user-facing changes
- Keep code comments clear and concise

### Features

- When adding new features, consider if they should be feature-gated
- Update `Cargo.toml` with new features if needed
- Document feature requirements in code

## Feature Guidelines

The library uses feature flags to allow users to opt-in to functionality:

- **Core features** (always available): Tree construction, basic rendering
- **Optional features**: `builder`, `iterator`, `formatters`, `color`

When adding new functionality:
- Consider if it should be a feature flag
- Update the `all` feature to include it
- Document it in the README

## Commit Messages

Write clear, descriptive commit messages:
- Use the imperative mood ("Add feature" not "Added feature")
- Keep the first line under 72 characters
- Include more details in the body if needed
- Reference issue numbers if applicable

Example:
```
Add support for custom tree styles

Implements StyleConfig::custom() method allowing users to define
their own character sets for tree rendering. Includes tests and
documentation updates.

Fixes #123
```

## Questions?

If you have questions about contributing, feel free to:
- Open an issue with the "question" label
- Check existing documentation
- Review existing code for examples

Thank you for contributing to TreeLog!