docs: clarify contribution fit#10378
Conversation
📝 WalkthroughWalkthroughTop-level ChangesContributing documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
Greptile SummaryThis documentation-only PR adds a "Contribution Expectations" section to
Confidence Score: 5/5Documentation-only change with no code modifications; safe to merge. All changes are prose updates to contribution guidance and a symlink conversion for CONTRIBUTING.md. No logic, configuration, or build artifacts are affected. No files require special attention. Important Files Changed
Reviews (6): Last reviewed commit: "docs: clarify contribution fit" | Re-trigger Greptile |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
CONTRIBUTING.md (2)
7-7: ⚡ Quick winDefine what "large PR" means to set contributor expectations.
The term "large PR" is ambiguous—does it refer to line count, complexity, scope, or impact? Contributors may interpret this differently and miss the opportunity to discuss before opening a PR.
Example clarification
-Before opening a large PR, please start with an issue or discussion so we can +Before opening a large PR (e.g., new features, significant refactors, or changes >100 lines), please start with an issue or discussion so we can🤖 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 7, Clarify the ambiguous term "large PR" by replacing or augmenting the sentence containing "large PR" with a concrete definition and examples: state measurable thresholds (e.g., >500 changed lines, >50 files, or changes that affect core architecture or public APIs), list types of changes that require prior discussion (architecture, data-migrations, public API changes, infra), and add a brief example guidance sentence showing when to open an issue/discussion first; update the CONTRIBUTING wording so contributors have clear, actionable criteria and an example.
5-10: ⚖️ Poor tradeoffClarify the relationship between this file and
docs/contributing.md.The "Project fit" section here overlaps with guidance already present in
docs/contributing.md(lines 7–19 in the code snippet), which also recommends discussing changes via discussion or Discord before opening PRs. Both files direct contributors to pre-discuss non-obvious changes, creating a maintenance burden if they diverge in the future.Consider whether this file is intended as a concise summary/entry point (GitHub's auto-discovered CONTRIBUTING.md at root level is a nice UX addition), or whether the guidance should be unified to a single source of truth. If this is a summary, clarify which details belong in which file.
To confirm the scope, please verify:
- Is
docs/contributing.mdthe same as the content at https://mise.en.dev/contributing.html?- Should this CONTRIBUTING.md file be a concise summary, or should detailed guidance live only in docs/?
🤖 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` around lines 5 - 10, The "Project fit" guidance in the root CONTRIBUTING.md duplicates content in docs/contributing.md; decide whether CONTRIBUTING.md should be a short summary or the single source of truth, confirm that docs/contributing.md matches the published page at https://mise.en.dev/contributing.html, then update the files accordingly: either (A) keep CONTRIBUTING.md as a concise entry point by replacing the full "Project fit" paragraph with a one-line summary that points to docs/contributing.md for details (and add a brief note clarifying which file holds detailed guidance), or (B) remove the duplicated guidance from CONTRIBUTING.md and add a clear link saying "see docs/contributing.md for full contributing guidelines"; in both cases edit the "Project fit" section in CONTRIBUTING.md (the header "Project fit") and ensure docs/contributing.md remains the canonical detailed version (no change needed there if it already matches the published URL) or update docs/contributing.md if the published page differs.
🤖 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 7: Clarify the ambiguous term "large PR" by replacing or augmenting the
sentence containing "large PR" with a concrete definition and examples: state
measurable thresholds (e.g., >500 changed lines, >50 files, or changes that
affect core architecture or public APIs), list types of changes that require
prior discussion (architecture, data-migrations, public API changes, infra), and
add a brief example guidance sentence showing when to open an issue/discussion
first; update the CONTRIBUTING wording so contributors have clear, actionable
criteria and an example.
- Around line 5-10: The "Project fit" guidance in the root CONTRIBUTING.md
duplicates content in docs/contributing.md; decide whether CONTRIBUTING.md
should be a short summary or the single source of truth, confirm that
docs/contributing.md matches the published page at
https://mise.en.dev/contributing.html, then update the files accordingly: either
(A) keep CONTRIBUTING.md as a concise entry point by replacing the full "Project
fit" paragraph with a one-line summary that points to docs/contributing.md for
details (and add a brief note clarifying which file holds detailed guidance), or
(B) remove the duplicated guidance from CONTRIBUTING.md and add a clear link
saying "see docs/contributing.md for full contributing guidelines"; in both
cases edit the "Project fit" section in CONTRIBUTING.md (the header "Project
fit") and ensure docs/contributing.md remains the canonical detailed version (no
change needed there if it already matches the published URL) or update
docs/contributing.md if the published page differs.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 56741f28-fb4a-40ea-a978-80e4b86b3c04
📒 Files selected for processing (1)
CONTRIBUTING.md
jdx
force-pushed
the
codex/contribution-review-guidance-20260613
branch
7 times, most recently
from
607d2c0 to
74ec1ea
Compare
jdx
force-pushed
the
codex/contribution-review-guidance-20260613
branch
from
74ec1ea to
66fb847
Compare
Hyperfine Performance
|
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.6.5 x -- echo |
19.5 ± 0.9 | 17.8 | 24.3 | 1.00 |
mise x -- echo |
20.3 ± 1.8 | 18.4 | 54.2 | 1.04 ± 0.10 |
mise env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.6.5 env |
19.0 ± 0.9 | 16.8 | 23.2 | 1.00 |
mise env |
19.5 ± 0.8 | 17.9 | 22.8 | 1.03 ± 0.06 |
mise hook-env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.6.5 hook-env |
19.6 ± 0.8 | 18.1 | 22.5 | 1.00 |
mise hook-env |
20.4 ± 1.0 | 18.5 | 24.1 | 1.04 ± 0.06 |
mise ls
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.6.5 ls |
16.2 ± 0.8 | 14.7 | 19.2 | 1.00 |
mise ls |
16.7 ± 0.8 | 15.4 | 20.6 | 1.03 ± 0.07 |
xtasks/test/perf
| Command | mise-2026.6.5 | mise | Variance |
|---|---|---|---|
| install (cached) | 133ms | 135ms | -1% |
| ls (cached) | 58ms | 58ms | +0% |
| bin-paths (cached) | 64ms | 66ms | -3% |
| task-ls (cached) | 126ms | 126ms | +0% |
1 participant
Summary
Tests