pgtrgm 0.2.0

PostgreSQL pg_trgm extension support for Diesel
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

# Contributing

Thank you for your interest in contributing to pgtrgm! We appreciate your help
in making this project better.

## Code of Conduct

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

## Getting Started

1. Fork the repository on GitHub
2. Clone your fork locally:
   ```bash
   git clone https://github.com/YOUR_USERNAME/pgtrgm.git
   cd pgtrgm
   ```
3. Add the upstream repository:
   ```bash
   git remote add upstream https://github.com/martsokha/pgtrgm.git
   ```

## Development Setup

### Prerequisites

- Rust 1.85 or later
- Cargo (comes with Rust)

### Building the Project

```bash
# Build with Diesel support
cargo build --features diesel

# Run tests
cargo test --all-features

# Check formatting
cargo fmt -- --check

# Run clippy
cargo clippy --all-targets --all-features -- -D warnings
```

## Making Changes

1. Create a new branch for your changes:
   ```bash
   git checkout -b feature/your-feature-name
   ```

2. Make your changes following our code style

3. Add tests for any new functionality

4. Ensure all tests pass:
   ```bash
   cargo test --all-features
   ```

5. Update documentation if needed

## Code Style

This project follows the standard Rust style guidelines:

- Run `cargo fmt` before committing
- Ensure `cargo clippy` passes with no warnings
- Add documentation comments (`///`) for public APIs
- Keep functions focused and reasonably sized

## Submitting Changes

1. Commit your changes with clear, descriptive commit messages

2. Push your changes to your fork:
   ```bash
   git push origin feature/your-feature-name
   ```

3. Create a Pull Request on GitHub

### Pull Request Guidelines

- Keep PRs focused on a single feature or fix
- Update CHANGELOG.md with your changes
- Ensure CI passes (tests, formatting, clippy)

## Reporting Bugs

If you find a bug, please create an issue on GitHub with:

- Steps to reproduce the issue
- Expected vs actual behavior
- Rust version and operating system

## License

By contributing, you agree that your contributions will be licensed under the
MIT License.