docs: clarify contribution fit

[jdx]

Summary

• make repository-root CONTRIBUTING.md the canonical full guide for GitHub contribution surfaces
• symlink docs/contributing.md back to the root guide for VitePress
• keep project-specific feature-bloat wording

Tests

• not run (documentation-only change)

---

Note

Low Risk
Documentation-only; no runtime, auth, or data-handling changes.

Overview
Adds contributor-facing documentation and surfaces it on the docs site.

Root CONTRIBUTING.md is a short GitHub-facing stub that links readers to the full guide at usage.jdx.dev/contributing.

docs/contributing.md is the full guide: discuss direction in Discord before large PRs, CI and AI review must be green before maintainer review, explicit stance on scope/fit and feature bloat, hk / mise workflow, Conventional Commits, and testing expectations.

VitePress sidebar gains a Contributing item pointing at /contributing.

^{Reviewed by Cursor Bugbot for commit 215b491. Bugbot is set up for automated code reviews on this repo. Configure here.}

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR adds initial contribution guidance to the repository. The new CONTRIBUTING.md file outlines the contribution process, project-fit considerations, and development setup steps including tool installation and pre-submission verification requirements.

Changes

Contribution Guidelines

Layer / File(s)	Summary
Contribution guidelines document CONTRIBUTING.md	Initial contribution documentation welcomes contributors, advises discussing scope and project-fit before starting large PRs, and documents the development setup process using mise install and repository checks.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A welcome thread for all who dare,
To build with care and thoughtful share,
With mise tools and checks so keen,
The cleanest code you've ever seen! 🐰✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title 'docs: clarify contribution fit' directly aligns with the main objective of documenting contribution fit requirements and adding initial CONTRIBUTING.md guidance.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

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

---

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

[greptile-apps]

Greptile Summary

Adds contributing guidance to the repository and docs site. A minimal stub CONTRIBUTING.md at the repo root redirects GitHub visitors to the hosted docs, while docs/contributing.md carries the full guide covering scope expectations, the hk/mise linting workflow, Conventional Commits, and testing conventions. The VitePress sidebar gains a new top-level Contributing link.

• CONTRIBUTING.md: Three-line stub that links GitHub contributors to https://usage.jdx.dev/contributing.
• docs/contributing.md: 61-line guide with contribution expectations (Discord-first, narrow scope, CI-green requirement), code style with hk, commit conventions, and testing notes.
• docs/.vitepress/config.mts: Inserts { text: "Contributing", link: "/contributing" } as the first sidebar entry.

Confidence Score: 5/5

Documentation-only change; no runtime or application code is touched.

All three changed files are Markdown or a single-line config addition. The new content is internally consistent, the VitePress link resolves to the newly added page, and there are no code paths affected.

No files require special attention.

Important Files Changed

Filename	Overview
CONTRIBUTING.md	New stub that redirects GitHub visitors to the full guide on the docs site; 3 lines, no issues.
docs/contributing.md	New full contributing guide covering expectations, hk/mise workflow, Conventional Commits, and testing; content is clear and well-structured.
docs/.vitepress/config.mts	Adds a Contributing entry to the top of the sidebar pointing to /contributing; straightforward config change.

_{Reviews (9): Last reviewed commit: "docs: make contributing guide canonical" | Re-trigger Greptile}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CONTRIBUTING.md`:
- Line 20: Update the CONTRIBUTING.md instruction to list the exact pre-PR
commands to run: add the four commands "mise r build", "mise r test", "mise r
render", and "mise r lint" (in that order) so contributors know to run the
render task that enforces a clean-diff; also mention that "mise r ci" currently
runs only "test" and "lint" and therefore is not a full replacement for running
build and render locally. Ensure the new text replaces or augments the existing
sentence "Run the checks listed in the repository before opening a PR." with the
explicit command list and the note about mise r ci.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: fc135934-1617-4389-b5ae-d5a3a33e7745

📥 Commits

Reviewing files that changed from the base of the PR and between 67c9434 and 41ec038.

📒 Files selected for processing (1)

• CONTRIBUTING.md

[coderabbitai]

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Specify the exact checks to run before opening a PR.

Line 20 advises to "run the checks listed in the repository," but does not enumerate them. Looking at the CI pipeline in .github/workflows/test.yml and mise.toml, contributors should run:

mise r build
mise r test
mise r render
mise r lint

The render task is particularly important—it has a clean-diff assertion in CI, so running it locally prevents failed checks. Alternatively, if mise r ci is intended as the primary pre-submission command, note that it currently depends only on test and lint, omitting build and render.

✏️ Proposed fix to clarify the checks

 Run the checks listed in the repository before opening a PR.
+
+```sh
+mise r build
+mise r test
+mise r render
+mise r lint
+```

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CONTRIBUTING.md` at line 20, Update the CONTRIBUTING.md instruction to list
the exact pre-PR commands to run: add the four commands "mise r build", "mise r
test", "mise r render", and "mise r lint" (in that order) so contributors know
to run the render task that enforces a clean-diff; also mention that "mise r ci"
currently runs only "test" and "lint" and therefore is not a full replacement
for running build and render locally. Ensure the new text replaces or augments
the existing sentence "Run the checks listed in the repository before opening a
PR." with the explicit command list and the note about mise r ci.