funlog 0.2.1

A procedural macro for tracing Rust function calls
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

# Contributing to Funlog

Thank you for your interest in contributing to Funlog! This document provides guidelines and information for contributors.

## 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 bug reports, please check the existing issues to avoid duplicates. When creating a bug report, please include:

- A clear and descriptive title
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Code examples
- Environment information (OS, Rust version, funlog version)

### Suggesting Features

Feature requests are welcome! Please provide:

- A clear and descriptive title
- Detailed description of the proposed feature
- Use cases and examples
- Any alternatives you've considered

### Pull Requests

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Add tests for your changes
5. Ensure all tests pass (`cargo test`)
6. Run formatting (`cargo fmt`)
7. Run clippy (`cargo clippy`)
8. Commit your changes (`git commit -m 'Add amazing feature'`)
9. Push to the branch (`git push origin feature/amazing-feature`)
10. Open a Pull Request

## Development Setup

### Prerequisites

- Rust (latest stable version)
- Git

### Setup

```bash
git clone https://github.com/koory1st/funlog.git
cd funlog
cargo build
cargo test
```

### Running Tests

```bash
# Run unit tests
cargo test

# Run all examples
./run_tests.sh

# Run specific example
cargo run --example raw_debug
```

### Code Style

- Use `cargo fmt` to format code
- Use `cargo clippy` to check for common mistakes
- Follow Rust naming conventions
- Add documentation for public APIs
- Write tests for new functionality

## Project Structure

```
funlog/
├── src/                    # Source code
│   ├── lib.rs             # Main library entry point
│   ├── config.rs          # Configuration structures
│   ├── config_builder.rs  # Configuration builder
│   ├── generics_item_fn.rs # Function analysis
│   └── output.rs          # Code generation
├── examples/              # Usage examples
├── tests/                 # Integration tests
├── .github/               # GitHub workflows and templates
└── docs/                  # Documentation
```

## Testing Guidelines

- Write unit tests for new functions
- Add integration tests for new features
- Include examples demonstrating new functionality
- Ensure all tests pass before submitting PR

## Documentation

- Update README.md for user-facing changes
- Add inline documentation for new public APIs
- Include examples in documentation
- Update CHANGELOG.md for releases

## Release Process

Releases are automated through GitHub Actions:

1. Update version in `Cargo.toml`
2. Update `CHANGELOG.md`
3. Create a git tag: `git tag v0.1.1`
4. Push tag: `git push origin v0.1.1`
5. GitHub Actions will automatically:
   - Run tests
   - Create GitHub release
   - Publish to crates.io

## Questions?

If you have questions about contributing, please:

1. Check existing issues and discussions
2. Create a new issue with the "question" label
3. Contact the maintainers

Thank you for contributing to Funlog!