zipatch-rs 1.5.0

Parser for FFXIV ZiPatch patch files
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

# Contributing

Outside contributions are welcome. The project is small; the workflow is light.

## Getting started

```bash
git clone https://github.com/reh3502/zipatch-rs
cd zipatch-rs
cargo test --features test-utils
```

The `test-utils` feature gates a `zipatch_rs::test_utils` module of fixtures the test suite uses. It is not part of the stable public API.

If you're working on the binary parser, XIVLauncher's C# implementation in [`FFXIVQuickLauncher`](https://github.com/goatcorp/FFXIVQuickLauncher/tree/master/src/XIVLauncher.Common/Patching/ZiPatch) is the primary reference for the ZiPatch format.

## Branch naming

Branch off `main` with one of these prefixes:

| Prefix | Use for |
|--------|---------|
| `feature/` | New features, additive work |
| `bug/` | Non-urgent bug fixes |
| `hotfix/` | Urgent production fixes |
| `chore/` | Dependencies, infra, tooling |
| `docs/` | Documentation-only changes |
| `release/` | Release-prep (version bump + CHANGELOG date stamp) |

Convention only; not server-enforced. The `release/*` prefix is the one the `Version bump` CI job watches for — every other prefix lets you land on `main` without a `Cargo.toml` bump. User-facing changes accumulate under `[Unreleased]` in `CHANGELOG.md` and ship in a dedicated `release/vX.Y.Z` PR.

## Commit discipline

One logical change per commit. The branch is squash-merged on land, so granular commits make review easier even though `main` only ever sees the single squashed entry.

Before pushing, run the same checks CI does:

```bash
cargo fmt
cargo clippy --all-features -- -D warnings
cargo test --features test-utils
```

## Opening a PR

The PR template asks for a Summary (1–3 bullets) and a Related link. Keep titles under 70 characters; put detail in the body.

CI runs Test / Clippy / Format / Audit / Coverage on Linux, Windows, and macOS plus an MSRV (Rust 1.85) build. Expect a few minutes end-to-end.

The maintainer reviews and merges. If you haven't heard back within a week, ping the PR.

## Reporting security issues

See [SECURITY.md](SECURITY.md). Don't open a public issue for a vulnerability.