You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CLAUDE.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,6 +55,14 @@ Run all tests with `cargo test`. There are three test suites:
55
55
56
56
Add a test for every new parser feature or key mapping. Integration tests should assert on specific keys at known positions in the example keymap.
57
57
58
+
## Releasing
59
+
60
+
1. Bump `version` in `Cargo.toml`.
61
+
2. Verify everything is green: `cargo test && cargo clippy --all-targets -- -W clippy::pedantic -D warnings`
62
+
3. Commit the version bump and push to `main`.
63
+
4. Run `make release` — this creates a `vX.Y.Z` git tag and pushes it to origin, which triggers the CI release workflow (`cargo-dist`) to build platform binaries and create a GitHub Release.
64
+
5. Run `cargo publish` — publishes the crate to crates.io. This step is not automated by CI and must be run manually.
65
+
58
66
## Key mapping conventions
59
67
60
68
QMK and ZMK use different names for the same physical keys. The canonical mapping lives in `src/codes.rs`. Notable differences:
0 commit comments