pravash 1.2.0

Fluid dynamics simulation — SPH, Euler/Navier-Stokes, shallow water, buoyancy, drag, vortex dynamics
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

# Contributing to pravash

Thank you for considering a contribution! This document covers the development
workflow, coding standards, and review process.

## Development Setup

```bash
# Clone the repository
git clone https://github.com/MacCracken/pravash.git
cd pravash

# Ensure you have the correct toolchain (see rust-toolchain.toml)
rustup show

# Run the full local CI suite
make check
```

## Pull Request Process

1. **Fork and branch** — create a feature branch from `main`.
2. **Keep commits focused** — one logical change per commit.
3. **Write tests** — new features require tests; bug fixes require a regression
   test.
4. **Run CI locally** before pushing:
   ```bash
   make check        # fmt + clippy + test + audit
   ```
5. **Open a PR** against `main` with a clear description of the change.
6. **Address review feedback** — maintainers may request changes before merging.

## Code Style

- Follow `rustfmt` defaults (enforced by CI).
- Zero clippy warnings (`cargo clippy --all-features --all-targets -- -D warnings`).
- Public API items must have doc comments.
- Use `#[inline]` on small, hot-path functions.
- Use `#[non_exhaustive]` on public enums and extensible structs.
- Physics functions must document units in their doc comments.

## Testing Requirements

- All public API changes must include unit tests.
- Integration tests go in `tests/`.
- Benchmarks go in `benches/` and should be run before/after performance-sensitive
  changes.
- Target: maintain or improve code coverage on every PR.

```bash
# Run tests
cargo test --all-features

# Run benchmarks
make bench

# Generate coverage report
make coverage
```

## Commit Messages

Use clear, imperative-mood commit messages:

```
add Manning's bed friction to shallow water solver

fix NaN handling in FluidConfig validation
```

## License

By contributing, you agree that your contributions will be licensed under the
same license as the project (see [LICENSE](LICENSE)).