Skip to content

feat(contributing): update criteria - #116

Merged
PVinaches merged 1 commit into
KaotoIO:mainfrom
PVinaches:contributing-main
Aug 6, 2026
Merged

feat(contributing): update criteria#116
PVinaches merged 1 commit into
KaotoIO:mainfrom
PVinaches:contributing-main

Conversation

@PVinaches

@PVinaches PVinaches commented Aug 5, 2026

Copy link
Copy Markdown
Member

As more PRs by external contributors are being opened, some of the repeated issues found have been added in the contributing guidelines

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines to require research-related work to be documented in an issue.
    • Clarified expectations for preventing regressions, maintaining code quality, and avoiding new static-analysis issues.
    • Extended these quality requirements to AI-assisted contributions.

@PVinaches
PVinaches requested a review from a team August 5, 2026 15:43
@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

CONTRIBUTING.md now requires issue documentation for research-tagged work and prohibits regressions and new SonarQube issues. It also defines pull request rejection criteria and applies SonarQube requirements to AI-generated code.

Changes

Contribution guidelines

Layer / File(s) Summary
Contribution requirement updates
CONTRIBUTING.md
The guidelines require issue documentation for research-tagged work, prohibit regressions and new SonarQube issues, define related pull request rejection criteria, and apply the SonarQube rule to AI-generated code.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • KaotoIO/forms#106: Updates the same AI-assisted contribution guidelines with SonarQube requirements.

Poem

A rabbit reads the rules with care,
Research notes now live elsewhere.
No regressions hop through the gate,
SonarQube keeps the code first-rate.
AI writes cleanly, crisp and bright.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies an update to the contribution criteria, which matches the pull request changes.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@sonarqubecloud

sonarqubecloud Bot commented Aug 5, 2026

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 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 45: Update the SonarQube references in CONTRIBUTING.md to use the
correctly capitalized product name, and rewrite the rejection rule around line
56 so its conditions are grammatically parallel and clearly refer to new issues
reported by SonarQube. Apply the same wording consistency to the additional
occurrences around lines 101 and 45.
- Line 35: Clarify the research-tag guidance in CONTRIBUTING.md by stating that
work associated with an issue tagged `research` must be documented in that issue
rather than submitted as a new pull request.
🪄 Autofix

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: d7c6dea5-7e2b-4240-9c51-193b97344cda

📥 Commits

Reviewing files that changed from the base of the PR and between 38fed9b and b6956c2.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md
@PVinaches
PVinaches merged commit 89da500 into KaotoIO:main Aug 6, 2026
7 checks passed
@PVinaches
PVinaches deleted the contributing-main branch August 6, 2026 08:09
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.

2 participants