Document mise install in CONTRIBUTING.md

[UniquePixels]

Context

Audit ID: DOC-3

Mise pins `bun@1.3.10` and `biome@2.4.6` via `.mise.toml` for reproducible environments, but CONTRIBUTING.md doesn't mention using `mise install`.

Approach

Add a note about mise in the development setup section of CONTRIBUTING.md.

Files

• `CONTRIBUTING.md`

[coderabbitai]

Coding Plan

Summary

• Enhance existing mise mentions in CONTRIBUTING.md rather than restructuring the document
• Focus on adding the "reproducibility" rationale that is currently missing
• Reference .mise.toml as the source of truth for pinned versions
• Maintain the existing documentation style and structure

Implementation Steps

Enhance mise Documentation in CONTRIBUTING.md

Improve the existing mise-related documentation to clearly communicate the reproducibility benefits and make the tooling setup more transparent to contributors.

Task 1: Clarify mise Purpose in Prerequisites Section

Expand the Prerequisites section to emphasize that mise provides reproducible environments by pinning exact tool versions, not just "correct versions."

• Update line 7 in CONTRIBUTING.md to mention that mise ensures reproducible environments by pinning exact versions from .mise.toml
• Consider adding a brief note that contributors will have identical tool versions, reducing "works on my machine" issues
• Keep the existing [!TIP] block for manual installation but ensure manual installers understand they should match the pinned versions

Task 2: Enhance Getting Started Explanation

Add context to the Getting Started section explaining what mise install accomplishes and why it matters.

• Expand the inline comment or add a brief note after the code block explaining that mise install reads .mise.toml and installs the exact pinned versions of Bun and Biome
• Emphasize that this ensures all contributors work with identical tooling for consistency
• Keep the change minimal and in line with the existing documentation style (concise, scannable)

🤖 Prompt for AI agents

Enhance the mise-related documentation in `CONTRIBUTING.md` to clearly
communicate reproducibility benefits and exact pinned tool versions.

**Task 1 – Prerequisites Section (around line 7):**
- Update the existing description of mise to mention that it ensures
**reproducible environments** by pinning exact versions sourced from
`.mise.toml` (e.g., `bun@1.3.10`, `biome@2.4.6`)
- Optionally add a brief note that all contributors will share identical tool
versions, eliminating "works on my machine" issues
- Preserve the existing `[!TIP]` block for manual installation; if appropriate,
add a note that manual installers should match the pinned versions specified in
`.mise.toml`

**Task 2 – Getting Started Section:**
- Expand the inline comment on the `mise install` command or add a short
explanatory note after the code block stating that `mise install` reads
`.mise.toml` and installs the exact pinned versions of Bun and Biome
- Reinforce that this guarantees all contributors work with identical tooling
- Keep additions minimal and consistent with the existing concise, scannable
documentation style

Research

CONTRIBUTING.md is a 134-line well-structured contributor guide with sections for Prerequisites, Getting Started, Development Workflow, Documentation, Submitting Changes, and more. The file already mentions mise install in the Getting Started code block with a brief comment, and the Prerequisites section notes that mise "installs Bun and Biome at the correct versions automatically." However, the documentation does not explain the reproducibility benefit or reference the exact pinned versions from .mise.toml (bun = "1.3.10", biome = "2.4.6").

---

🚀 Next Steps

🤖 All AI agent prompts combined

Enhance the mise-related documentation in `CONTRIBUTING.md` to clearly
communicate reproducibility benefits and exact pinned tool versions.

**Task 1 – Prerequisites Section (around line 7):**
- Update the existing description of mise to mention that it ensures
**reproducible environments** by pinning exact versions sourced from
`.mise.toml` (e.g., `bun@1.3.10`, `biome@2.4.6`)
- Optionally add a brief note that all contributors will share identical tool
versions, eliminating "works on my machine" issues
- Preserve the existing `[!TIP]` block for manual installation; if appropriate,
add a note that manual installers should match the pinned versions specified in
`.mise.toml`

**Task 2 – Getting Started Section:**
- Expand the inline comment on the `mise install` command or add a short
explanatory note after the code block stating that `mise install` reads
`.mise.toml` and installs the exact pinned versions of Bun and Biome
- Reinforce that this guarantees all contributors work with identical tooling
- Keep additions minimal and consistent with the existing concise, scannable
documentation style

💡 Iterate on the plan with: @coderabbitai <feedback>

Example Feedback
- `@coderabbitai` You can skip phase 3. Add a simple unit test case for phase 2.
- `@coderabbitai` For design choice 1 go ahead with option 3 and replan.

---

💬 Have feedback or questions? Drop into our discord!