12 add magic file format detection subtask 143

[unclesp1d3r]

This pull request introduces major documentation and configuration updates to support the Phase 1 MVP of libmagic-rs. The changes focus on contributor onboarding, project planning, CLI enhancements, and build-time support for built-in magic rules. These improvements clarify project architecture, establish development standards, and outline the technical approach for key upcoming features.

Documentation and Contributor Experience:

• Added a comprehensive CONTRIBUTING.md guide detailing code standards, testing, documentation, branching, and error handling for all contributors.
• Created an epic brief (docs/plan/phase_1_mvp/specs/Epic_Brief__libmagic-rs_Phase_1_MVP.md) outlining the goals, context, scope, and value proposition for the Phase 1 MVP, including compatibility, safety, and documentation requirements.

Technical Planning for Core Features:

• Added a technical specification for build-time compilation of built-in magic rules (docs/plan/phase_1_mvp/tickets/Built-in_Rules__Build-Time_Compilation_&_Fallback.md), describing the use of a build script, fallback rules, and new APIs for rule loading.
• Documented CLI enhancements (docs/plan/phase_1_mvp/tickets/CLI_Enhancements__Multiple_Files,_Stdin,_Magic_Discovery.md) including support for multiple files, stdin, improved magic file discovery, new flags (--use-builtin, --strict), and robust error/output handling. (docs/plan/phase_1_mvp/tickets/CLI_Enhancements__Multiple_Files,_Stdin,_Magic_Discovery.mdR1-R241)

Development Environment Improvements:

• Updated .vscode/settings.json to configure ruff and Python interpreter paths for consistent linting and formatting in the development environment.

Miscellaneous:

• Minor cleanup in dist-workspace.toml for release configuration.

These changes lay the groundwork for the next development phase, ensuring clarity, maintainability, and a strong foundation for new features and contributor engagement.

[coderabbitai]

Caution

Review failed

Failed to post review comments

Summary by CodeRabbit

• Documentation

  • Added comprehensive contributing guidelines and project architecture documentation
  • Expanded getting started guide with examples and public API usage patterns
  • Updated project status to "Active Development" with new capability overviews
  • Enhanced architecture documentation with visual diagrams

• Chores

  • Updated Rust toolchain to 1.91.0 and bumped dependencies (clap, memmap2, serde_json, insta, tempfile, etc.)
  • Refactored GitHub Actions workflows to use centralized tooling setup via mise-action
  • Added mise.toml tool configuration
  • Reorganized justfile to consolidate build commands

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

Adds extensive documentation and planning for a Phase 1 MVP, a new CONTRIBUTING guide, tooling/config updates (VSCode, mise.toml, rust-toolchain, Cargo), CI/workflow consolidation to jdx/mise-action@v3, justfile reorganizations, and minor repo infra edits. Mostly docs and infra/config changes; no broad API-breaking code changes reported.

Changes

Cohort / File(s)	Summary
Editor & Tooling settings \.vscode/settings.json, mise.toml, rust-toolchain.toml	Adds VSCode settings for ruff and Python interpreter under .vscode/mise-tools/...; introduces mise.toml tool pins; bumps toolchain to 1.91.0 (formatting only on components list).
Contribution guide CONTRIBUTING.md	Adds a new, comprehensive contributing guide (CoC, setup, development workflow, testing, PR template, Rust style/safety guidance).
Phase 1 MVP specs & tickets docs/plan/phase_1_mvp/specs/*, docs/plan/phase_1_mvp/tickets/*	Adds many new design/spec and ticket documents covering Epic, Technical Plan, Core Flows, built-in rules, CLI enhancements, parser integration, evaluation enhancements (confidence/MIME/tags/metadata), strength calculation, testing infra, and documentation plans.
Documentation & research docs/src/*, docs/research/*, docs/book.toml, docs/plan/*	Large doc additions and revisions: new research and architecture docs, Mermaid diagrams replacing ASCII art, expanded Getting Started/Introduction and examples, mdBook config reflow and preprocessors adjusted.
CI / GitHub workflows .github/workflows/* (e.g., \.github/workflows/audit.yml, ci.yml, codeql.yml, compatibility.yml, docs.yml, security.yml, copilot-setup-steps.yml)	Replaces actions/checkout v5→v6 and consolidates per-job Rust/tool setup into jdx/mise-action@v3 (install/cache/github_token), centralizing installs and caching across workflows; some rust-toolchain/setup steps removed.
Parser / Evaluation API (planning notes) docs/plan/...	Documents proposed public API additions and behavior (e.g., MagicDatabase builder methods, EvaluationResult/Metadata/MatchResult, MimeMapper, TagExtractor, MagicFileFormat/detection, builtin rules build-time flow). Changes appear as design/spec text rather than implemented code in this diff.
Build / repo automation justfile, .pre-commit-config.yaml, .gitignore, Cargo.toml	Consolidates justfile recipes into private wrappers and adjusts public entries, updates pre-commit hooks, adds .gitignore entry undefined/, and bumps various dependencies in Cargo.toml.
mdBook/site config docs/book.toml	Reflows and aligns mdBook keys, removes or disables some preprocessors, and adjusts HTML output config formatting (cosmetic).
Small infra files .serena/project.yml, .serena/.gitignore, dist-workspace.toml	Adds Serenа project config and .serena ignore, minor whitespace/formatting tweaks in dist-workspace.toml.

Sequence Diagram(s)

(omitted — changes are primarily documentation and infra; no new multi-component control flow added that requires sequence visualization)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐰 I hop through specs and tidy up the lair,
Docs stacked like carrots, workflows trimmed with care,
CONTRIBUTING stitched, tools pinned in neat rows,
Tickets sketch paths where future logic grows,
A small rabbit cheers — MVP seeds sown fair.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title '12 add magic file format detection subtask 143' is partially related but overly broad and vague. It references a ticket/subtask number rather than clearly describing the main change.	Revise the title to clearly describe the primary change, such as 'Add Phase 1 MVP planning and contributing documentation' or 'Add CONTRIBUTING guide and Phase 1 MVP specifications.' Avoid vague issue references as the primary description.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description is comprehensive and directly related to the changeset, providing clear context for documentation updates, CLI enhancements, and configuration changes that align with the files and objectives listed.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 12-add-magic-file-format-detection-subtask-143

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!