Skip to content

chore: add LICENSE, PR-time CI, Cargo metadata; fix README placeholders; cargo fmt - #12

Merged
eunhhu merged 2 commits into
mainfrom
devin/1776995379-polish-and-fixes
Apr 24, 2026
Merged

eunhhu merged 2 commits into
mainfrom
devin/1776995379-polish-and-fixes

Conversation

@devin-ai-integration

Copy link
Copy Markdown

Summary

Fills in the missing "published crate" hygiene. No runtime behaviour change — the biggest chunk of diff is a project-wide cargo fmt --all to make the new CI's format check pass.

Licensing

  • Added LICENSE. Cargo.toml declared license = "MIT" but no file was checked in. Added the standard MIT text.
  • README license section was a literal placeholder ([Add your license information here]) — replaced with a link to LICENSE.

Cargo metadata

Added authors, repository, homepage, readme, keywords, categories, and rust-version = "1.70" to [package]. This makes cargo publish produce a useful crates.io page instead of a stub.

CI

  • New .github/workflows/ci.yml. The only existing workflows (release.yml, publish-crates.yml) run on git tags, so regular PRs got zero automated validation. The new workflow runs on every push/PR:
    • Installs libclang-dev / clang so frida-sys' bindgen build can find libclang.
    • cargo fmt --all -- --check
    • cargo clippy --all-targets (does NOT pass -D warnings — the pre-existing tree has 28 warnings; tightening is a separate cleanup).
    • cargo build
    • cargo test --all (all 18 existing unit tests pass).

README polish

  • Added centred header with License / crates.io / Rust badges.
  • Replaced two your-username placeholders in clone URL and issues link with eunhhu.

Formatting

  • Ran cargo fmt --all. Only touches src/gum/commands/*.rs, src/gum/memory.rs, src/gum/store.rs, src/gum/vzdata.rs. Pure formatting; no logic changes.

Review & Testing Checklist for Human

  • Confirm the cargo-fmt diff is indeed pure formatting (spot-check src/gum/commands/disasm_cmds.rs and src/gum/memory.rs).
  • cargo build && cargo test still passes locally (mirrors what CI does).
  • You're OK with clippy running as a warn-only step for now (the repo has 28 pre-existing warnings; tightening is out of scope for this PR).

Notes

  • The existing release.yml / publish-crates.yml workflows are unchanged; they continue to run only on v*.*.* tags.
  • No dependency version changes.

Link to Devin session: https://app.devin.ai/sessions/3e6146e428b74cc6bc973143697be3eb
Requested by: @eunhhu

@devin-ai-integration

Copy link
Copy Markdown
Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@eunhhu
eunhhu merged commit f716e3a into main Apr 24, 2026
1 check passed
@eunhhu
eunhhu self-requested a review April 24, 2026 02:53
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.

2 participants