Skip to content

Document mise setup and link CI failures to CONTRIBUTING.md#51

Merged
brylie merged 2 commits into
mainfrom
feature/improve-contributor-guidance-and-automation
Jun 28, 2026
Merged

Document mise setup and link CI failures to CONTRIBUTING.md#51
brylie merged 2 commits into
mainfrom
feature/improve-contributor-guidance-and-automation

Conversation

@brylie

@brylie brylie commented Jun 28, 2026

Copy link
Copy Markdown
Member

Summary

  • Two prek hooks (actionlint, markdownlint-cli2) run through mise exec --, but neither the dev container nor the manual setup docs installed mise -- so following CONTRIBUTING.md as written left those two hooks failing with "command not found". Added the mise devcontainer feature plus mise install to postCreateCommand, and documented the manual install step for non-container setups.
  • Each CI failure (prek/mypy/pyrefly/pytest/coverage) in the job summary and sticky PR comment now links to the specific CONTRIBUTING.md section for that check, instead of generic "see CI" feedback.

Test plan

  • python3 -c "import yaml; ..." / json.load confirm valid YAML/JSON
  • actionlint .github/workflows/ci.yaml passes
  • prek run --files ... passes on all changed files
  • Confirm on this PR's own CI run that failure comments/summaries render the new CONTRIBUTING.md links correctly
  • Spin up a fresh Codespace/dev container and confirm mise install runs and prek run --all-files no longer fails on the mise-dependent hooks

Two prek hooks (actionlint, markdownlint-cli2) run through `mise exec
--` but neither the dev container nor the manual setup docs installed
mise, so following CONTRIBUTING.md as written would leave those two
hooks failing with "command not found". Add the mise devcontainer
feature plus `mise install` to postCreateCommand, and document the
manual install step.

Also link each CI failure (prek/mypy/pyrefly/pytest/coverage) in the
job summary and sticky PR comment to the relevant CONTRIBUTING.md
section, so contributors land on the exact instructions for the
check that actually failed instead of generic "see CI" feedback.
@coderabbitai

coderabbitai Bot commented Jun 28, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@brylie, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 26 minutes and 40 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 23ea41ef-2dd1-4492-9c95-fe988705bb3e

📥 Commits

Reviewing files that changed from the base of the PR and between 7dd076d and e67f3de.

📒 Files selected for processing (3)
  • .devcontainer/devcontainer.json
  • .github/workflows/ci.yaml
  • CONTRIBUTING.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/improve-contributor-guidance-and-automation

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

Test Coverage Report

87% coverage (required: ≥80%)

Coverage meets the project threshold. 🎉

When any check fails, the sticky comment now opens with a polite,
@-mentioned summary of which stages need attention (e.g. "Lint
(prek), Tests (pytest)") before pointing to the per-check details and
CONTRIBUTING.md links already below it. Since the comment is updated
in place on reruns rather than recreated, the mention only notifies
once per PR.
@brylie
brylie merged commit f0a2ca9 into main Jun 28, 2026
6 checks passed
@brylie
brylie deleted the feature/improve-contributor-guidance-and-automation branch June 28, 2026 13:49
@sonarqubecloud

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant