majra 1.0.1

Distributed queue & multiplex engine — pub/sub, priority queues, relay, IPC, heartbeat, and rate limiting for Rust
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

# Contributing to majra

Thank you for your interest in contributing to majra. This document covers the
development workflow, code standards, and project conventions.

## Development Workflow

1. **Fork** the repository on GitHub.
2. **Create a branch** from `main` for your work.
3. **Make your changes**, ensuring all checks pass.
4. **Open a pull request** against `main`.

## Prerequisites

- Rust toolchain (MSRV: **1.89**)
- `cargo-deny` — supply chain checks
- `cargo-fuzz` — fuzz testing (requires nightly)
- `cargo-llvm-cov` — code coverage

## Makefile Targets

| Target          | Description                                      |
| --------------- | ------------------------------------------------ |
| `make check`    | Run fmt + clippy + test + audit (the full suite) |
| `make fmt`      | Format code with `cargo fmt`                     |
| `make clippy`   | Lint with `cargo clippy`                         |
| `make test`     | Run the test suite                               |
| `make deny`     | Audit dependencies with `cargo deny`             |
| `make fuzz`     | Run fuzz targets                                 |
| `make coverage` | Generate code coverage report                    |

Before opening a PR, run `make check` to verify everything passes.

## Adding a New Module

1. Create `src/module.rs` with your implementation.
2. Add the module to `src/lib.rs` (feature-gated if appropriate).
3. Add unit tests in the module file under `#[cfg(test)]`.
4. Add the feature flag to `Cargo.toml` if applicable.
5. Update `README.md` with the new module's feature table entry.

## Code Style

- Run `cargo fmt` before committing. All code must be formatted.
- `cargo clippy -D warnings` must pass with no warnings.
- All public items (functions, structs, enums, traits, type aliases) must have
  doc comments.
- Keep functions focused and testable.
- Use `#[non_exhaustive]` on public enums for forward compatibility.

## Testing

- Unit tests go in the module file under `#[cfg(test)]`.
- Concurrent types must have multi-thread tests.
- Property-based and fuzz tests are encouraged for serialisation paths.
- All new features require tests before merge.

## License

majra is licensed under **AGPL-3.0-only**. All contributions must be compatible
with this license. By submitting a pull request, you agree that your
contribution is licensed under the same terms.