docs: clarify contribution fit by jdx · Pull Request #545 · jdx/fnox

jdx · 2026-06-13T05:17:54Z

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 changes with no runtime or security impact.

Overview
Adds contributor-facing documentation: a root CONTRIBUTING.md that points readers to the published site guide, and a new docs/contributing.md page with expectations (scope, Discord, CI/AI review gates, rejection policy), plus hk/mise workflow, Conventional Commits, testing, and development setup.

The VitePress Introduction sidebar now includes a Contributing link to /contributing.

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

coderabbitai · 2026-06-13T05:18:06Z

📝 Walkthrough

Walkthrough

This PR adds initial CONTRIBUTING.md documentation to the fnox repository, establishing contribution guidelines, project scope expectations, and a basic development setup checklist using mise and repository checks.

Changes

Contribution Documentation

Layer / File(s)	Summary
Initial CONTRIBUTING.md `CONTRIBUTING.md`	Introduces full contribution documentation covering contribution expectations, project fit guidance, and development checklist (mise install and repo checks).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops with joy so bright,
Contributing guide takes flight!
"Start with an issue," the message reads,
"Run your checks before you proceed!"
🐰✨📝

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: clarify contribution fit' directly matches the PR's main objective of adding CONTRIBUTING.md documentation that clarifies contribution requirements and project scope fit.
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 · 2026-06-13T05:19:02Z

Greptile Summary

Adds contributor documentation: a root CONTRIBUTING.md that redirects GitHub visitors to the hosted guide, the full docs/contributing.md covering discussion etiquette, code style, conventional commits, testing, and dev setup, and a sidebar entry in VitePress.

CONTRIBUTING.md is a thin redirect to https://fnox.jdx.dev/contributing; the actual guidance lives in docs/contributing.md.
docs/contributing.md covers hk linting (with a note to prefer mise run lint/mise run lint-fix when available), conventional commits, and testing guidance.
docs/.vitepress/config.mjs adds a "Contributing" link in the Introduction sidebar group between "Quick Start" and "How It Works".

Confidence Score: 5/5

Documentation-only change with no runtime, data, or configuration impact.

All three files are purely documentation. The root redirect, the contributing guide content, and the sidebar config change are all straightforward and consistent with the rest of the project's conventions.

No files require special attention.

Important Files Changed

Filename	Overview
CONTRIBUTING.md	New 3-line root file that redirects GitHub visitors to the full guide at fnox.jdx.dev/contributing
docs/contributing.md	New full contributing guide covering discussion expectations, code style (hk + mise wrappers), conventional commits, testing, and dev setup
docs/.vitepress/config.mjs	Adds "Contributing" sidebar entry under Introduction, linking to /contributing

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

greptile-apps · 2026-06-13T05:19:05Z

+mise install
+```
+
+Run the checks listed in the repository before opening a PR.


The phrase "the checks listed in the repository" is ambiguous — CLAUDE.md already documents the exact command (mise run ci). Pointing contributors directly to that command (or to CLAUDE.md) removes any guesswork.

Suggested change

Run the checks listed in the repository before opening a PR.

Run `mise run ci` (build + test + lint) before opening a PR. See `CLAUDE.md` for the full list of available commands.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

coderabbitai

🧹 Nitpick comments (1)

CONTRIBUTING.md (1)
20-20: ⚡ Quick win

Clarify which specific checks contributors should run locally.

The phrase "checks listed in the repository" is vague and may leave contributors uncertain about which commands to run. The mise.toml file defines several tasks (test, lint, build), and mise run ci runs all of them together. Explicitly mention the command(s) contributors should execute before opening a PR.
💡 Suggested improvement
  Run the checks listed in the repository before opening a PR.
+ Run `mise run ci` to execute the full check suite (build, test, lint).
Alternatively, list individual commands:
  Run the checks listed in the repository before opening a PR.
+ 
+ ```sh
+ mise run ci        # Run build, test, and lint
+ ```
+ 
+ Or run individual steps:
+ - `mise run build` to build the project
+ - `mise run test` to run tests
+ - `mise run lint` to check code style and quality
🤖 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, Replace the vague sentence "Run the checks
listed in the repository before opening a PR." with explicit commands: ask
contributors to run `mise run ci` (which executes build, test, and lint) or,
optionally, run individual tasks `mise run build`, `mise run test`, and `mise
run lint` locally; include a short example snippet showing `mise run ci` and the
three individual commands so it's unambiguous which checks are required.

🤖 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.

Nitpick comments:
In `@CONTRIBUTING.md`:
- Line 20: Replace the vague sentence "Run the checks listed in the repository
before opening a PR." with explicit commands: ask contributors to run `mise run
ci` (which executes build, test, and lint) or, optionally, run individual tasks
`mise run build`, `mise run test`, and `mise run lint` locally; include a short
example snippet showing `mise run ci` and the three individual commands so it's
unambiguous which checks are required.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 4989694d-6547-45e0-bbbe-5251344c9d3f

📥 Commits

Reviewing files that changed from the base of the PR and between ddf2524 and 657980f.

📒 Files selected for processing (1)

CONTRIBUTING.md

greptile-apps Bot reviewed Jun 13, 2026

View reviewed changes

coderabbitai Bot reviewed Jun 13, 2026

View reviewed changes

jdx force-pushed the codex/contribution-review-guidance-20260613 branch 10 times, most recently from f071edd to 563ffd1 Compare June 13, 2026 05:36

docs: clarify contribution fit

2f897a5

jdx force-pushed the codex/contribution-review-guidance-20260613 branch from 563ffd1 to 2f897a5 Compare June 13, 2026 05:38

docs: make contributing guide canonical

0706ba0

jdx merged commit 30e0590 into main Jun 13, 2026
14 checks passed

jdx deleted the codex/contribution-review-guidance-20260613 branch June 13, 2026 06:12

mise-en-dev mentioned this pull request Jun 13, 2026

chore: release v1.26.1 #544

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: clarify contribution fit#545

docs: clarify contribution fit#545
jdx merged 2 commits into
mainfrom
codex/contribution-review-guidance-20260613

jdx commented Jun 13, 2026 •

edited by cursor Bot

Loading

Uh oh!

coderabbitai Bot commented Jun 13, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

greptile-apps Bot commented Jun 13, 2026 •

edited

Loading

Uh oh!

greptile-apps Bot Jun 13, 2026

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	Run the checks listed in the repository before opening a PR.
	Run `mise run ci` (build + test + lint) before opening a PR. See `CLAUDE.md` for the full list of available commands.

Uh oh!

Conversation

jdx commented Jun 13, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Tests

Uh oh!

coderabbitai Bot commented Jun 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

greptile-apps Bot commented Jun 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Uh oh!

greptile-apps Bot Jun 13, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

jdx commented Jun 13, 2026 •

edited by cursor Bot

Loading

coderabbitai Bot commented Jun 13, 2026 •

edited

Loading

greptile-apps Bot commented Jun 13, 2026 •

edited

Loading