Skip to content

Polish repo for release readiness: license, contributing guide, crate metadata, README - #1

Merged
aytzey merged 1 commit into
mainfrom
claude/us-work-visa-guide-ebtlkm
Jul 8, 2026
Merged

Polish repo for release readiness: license, contributing guide, crate metadata, README#1
aytzey merged 1 commit into
mainfrom
claude/us-work-visa-guide-ebtlkm

Conversation

@aytzey

@aytzey aytzey commented Jul 8, 2026

Copy link
Copy Markdown
Owner

Brings the repository up to release/showcase quality — no code changes, only packaging and documentation.

Changes

  • LICENSE: add MIT license.
  • CONTRIBUTING.md: contributor guide with the exact CI checklist (fmt, clippy -D warnings, tests, e2e.sh), code conventions (compiler-passthrough guarantee, spec-update rule, golden samples for extractor changes), and issue-reporting guidance.
  • Crate metadata: workspace.package with license/repository/keywords/categories inherited by both crates, plus per-crate descriptions. Both crates now pass cargo package validation, so they are crates.io-ready.
  • README: CI/license/Rust/MCP badges, a positioning paragraph under the tagline, a cargo install section, and Contributing/License sections.

Verification

  • cargo build --workspace
  • cargo test --workspace — all 20 suites pass ✅
  • cargo fmt --check and cargo clippy --workspace --all-targets -- -D warnings
  • ./scripts/e2e.sh (offline, llm-mode off) ✅
  • cargo package --list validates for both crates ✅

🤖 Generated with Claude Code

https://claude.ai/code/session_012Hk9jCjBFpqXjJEyZEFwNr


Generated by Claude Code

Summary by CodeRabbit

  • Documentation

    • Expanded the README with clearer setup, install, CI, security, and licensing information.
    • Added contribution guidelines covering local setup, checks to run before opening a PR, and issue reporting expectations.
  • Chores

    • Consolidated project metadata into shared workspace settings for cleaner package configuration.
    • Updated licensing and package details to match the current project setup.

… metadata, README

- Add MIT LICENSE and CONTRIBUTING.md with the exact CI checklist and
  code conventions (passthrough guarantee, spec-update rule, golden samples)
- Add workspace.package metadata (license, repository, keywords,
  categories) and per-crate descriptions so both crates pass
  `cargo package` validation
- README: CI/license/MCP badges, positioning paragraph under the
  tagline, cargo-install instructions, license section, contributing
  pointer
@aytzey
aytzey merged commit 4f23d59 into main Jul 8, 2026
1 check passed
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4a459a81-6e9f-44f2-9a07-4fd900672b7c

📥 Commits

Reviewing files that changed from the base of the PR and between 3c3faf0 and d3cd207.

📒 Files selected for processing (6)
  • CONTRIBUTING.md
  • Cargo.toml
  • LICENSE
  • README.md
  • crates/mcpcc-mcp-server/Cargo.toml
  • crates/mcpcc/Cargo.toml

📝 Walkthrough

Walkthrough

Adds CONTRIBUTING.md and LICENSE files, expands README.md with badges, install instructions, CI overview, security note, and license section, and introduces workspace-level package metadata in Cargo.toml consumed by crates/mcpcc-mcp-server and crates/mcpcc manifests.

Changes

Project metadata and documentation setup

Layer / File(s) Summary
Contribution guide and license
CONTRIBUTING.md, LICENSE
Adds contributor setup/CI-check/issue-reporting guidance and the MIT license text with 2026 copyright.
README updates
README.md
Adds badges, expanded intro, an Install section, plus CI overview, security note, and license section.
Workspace package metadata and crate manifests
Cargo.toml, crates/mcpcc-mcp-server/Cargo.toml, crates/mcpcc/Cargo.toml
Adds a workspace.package section with shared metadata and updates both crate manifests to inherit it via *.workspace = true, adding crate descriptions.

Estimated code review effort: 1 (Trivial) | ~5 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/us-work-visa-guide-ebtlkm

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@aytzey
aytzey deleted the claude/us-work-visa-guide-ebtlkm branch July 8, 2026 14:07
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