Skip to content

Prepare crate for crates.io and polish repo - #1

Merged
Arkptz merged 11 commits into
mainfrom
feat/publish-ready
Apr 20, 2026
Merged

Prepare crate for crates.io and polish repo#1
Arkptz merged 11 commits into
mainfrom
feat/publish-ready

Conversation

@Arkptz

@Arkptz Arkptz commented Apr 20, 2026

Copy link
Copy Markdown
Owner

Fills the metadata and tooling gaps needed to publish to crates.io and generally tidy up the repo.

Changes

  • `Cargo.toml`: description, license, repository, keywords, categories, MSRV, docs.rs config
  • `LICENSE`: MIT
  • `README.md`: centered hero with badges, explicit feature list, collapsible CLI reference, contributing link, typo fix on the Python project link
  • `src/lib.rs`: crate-level rustdoc
  • CI: `cargo-audit` and MSRV (1.88) jobs; dependabot (weekly, grouped) for cargo + GitHub Actions
  • Release: add `aarch64-unknown-linux-gnu` target via `cross`
  • Release-plz: workflow + config for automated version bumps, `CHANGELOG.md`, and `cargo publish` driven by conventional commits
  • Nix flake: `packages.default` so `nix run github:Arkptz/mitm2openapi` works
  • Community: `SECURITY.md`, `CODE_OF_CONDUCT.md` (Contributor Covenant 2.1), issue templates, PR template

MSRV

Pinned at 1.88. `har 0.9.0` pulls in `serde_with 3.18` → `darling 0.23`, each declaring that floor. Stable is 1.95, so this is stable − 7 (in line with bat / oha).

Verification

  • `cargo fmt --all --check`
  • `cargo clippy --all-targets -- -D warnings`
  • `cargo test --lib` — 187 pass
  • `cargo publish --dry-run`

Arkptz added 11 commits April 20, 2026 19:41
Fill description, license, repository, keywords, categories, MSRV, and
docs.rs config so the crate can be published. MSRV pinned at 1.88 to
match the har 0.9 dependency chain.
- Centered hero with 6 badges (CI, nightly integration, crates.io
  version/downloads, docs.rs, license)
- Explicit feature bullet list above install section
- Wrap CLI reference tables in collapsible <details>
- Link CONTRIBUTING.md
- Fix typo in link to original Python project (alufers, not aluber)
Conventional commits drive version bumps: fix: → patch, feat: → minor,
feat!: → major. release-plz opens a Release PR; merging it tags a
release and runs cargo publish.
Contributor Covenant 2.1; vulnerability reports routed through GitHub
Security Advisories.
@Arkptz
Arkptz merged commit 87a8a72 into main Apr 20, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant