Skip to content

chore: distill review conventions into AGENTS.md and CodeRabbit - #13597

Open
ChristophWurst wants to merge 1 commit into
mainfrom
chore/coderabbit-config-from-review-history
Open

chore: distill review conventions into AGENTS.md and CodeRabbit#13597
ChristophWurst wants to merge 1 commit into
mainfrom
chore/coderabbit-config-from-review-history

Conversation

@ChristophWurst

@ChristophWurst ChristophWurst commented Aug 31, 2026

Copy link
Copy Markdown
Member

Add an author-facing "Coding conventions" section to AGENTS.md and mirror it per path in .coderabbit.yaml so contributors get the same feedback up front that a review would raise, and reviews can focus on design.

The conventions are distilled from this repository's recurring review remarks and the Nextcloud developer manual's coding standards. CodeRabbit does not read AGENTS.md automatically, so the substance is repeated per path; the two files are meant to be updated together.

Vendored code stays reviewable (only bundled/generated output is filtered) so the bot can still look at human-relevant files such as composer.json.

Assisted-by: Claude Code:claude-opus-4-8

🤖 AI (if applicable)

  • The content of this PR was partly or fully generated using AI

Summary by CodeRabbit

  • Documentation

    • Added comprehensive coding conventions for backend, frontend, database migrations, testing, accessibility, internationalization, performance, and API boundaries.
    • Expanded contribution guidance for pull request scope, commit types, typed code, error handling, mocking, and edge-case testing.
    • Added guidance on formatter-enforced style and AI/agent disclosure.
  • Chores

    • Updated automated review settings with English-language guidance, assertive feedback, advisory-only findings, and generated-file filtering.

@ChristophWurst ChristophWurst self-assigned this Aug 31, 2026
@nextcloud-command nextcloud-command added the AI assisted This PR contains AI-assisted commits label Aug 31, 2026
@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2f0e27b3-8514-4054-a35b-213e907563a9

📥 Commits

Reviewing files that changed from the base of the PR and between 08c85b9 and 2c0675d.

📒 Files selected for processing (1)
  • .coderabbit.yaml

Included review availability: Your plan provides up to 4 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

Expanded .coderabbit.yaml with review language, advisory review behavior, path filters, and repository-wide instructions. Added AGENTS.md conventions for backend, database, frontend, testing, accessibility, internationalization, and mail-specific code.

Changes

Review guidance

Layer / File(s) Summary
Review policy and repository standards
.coderabbit.yaml, AGENTS.md
Configured review language, assertive profile, advisory findings, excluded generated paths, AI disclosure requirements, contribution scope, commit types, and helper reuse.
Backend and database guidance
AGENTS.md
Added PHP, controller, mapper, entity, migration, database, API, performance, and IMAP identifier conventions.
Frontend and internationalization guidance
AGENTS.md
Added JavaScript, Vue, styling, asynchronous code, translation, and accessibility conventions.
Testing guidance
AGENTS.md
Added requirements for error and edge-path coverage, typed fixtures, external-only mocks, argument-based assertions, shared constants, and maintained API stubs.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: 🟡 Moderate · up to 2c067

The review configuration does not yet mirror the conventions documented in AGENTS.md, so the intended automated guidance will not take effect consistently. This leaves the PR’s primary behavior incomplete and should be fixed before merge.

Suggested reviewers: gretad, kesselb

🚥 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 and concisely describes the main change: adding review conventions to AGENTS.md and CodeRabbit configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/coderabbit-config-from-review-history

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.

@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


ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 11880347-bfbc-4976-96b6-7962a4801757

📥 Commits

Reviewing files that changed from the base of the PR and between f24443a and 9e3a730.

📒 Files selected for processing (2)
  • .coderabbit.yaml
  • AGENTS.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Comment thread .coderabbit.yaml Outdated
Comment thread .coderabbit.yaml Outdated
@ChristophWurst
ChristophWurst force-pushed the chore/coderabbit-config-from-review-history branch from e671516 to fdda8aa Compare August 31, 2026 15:14
@ChristophWurst

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@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


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 7410cad0-fad8-4784-b614-1fd479bcf54d

📥 Commits

Reviewing files that changed from the base of the PR and between 9e3a730 and fdda8aa.

📒 Files selected for processing (2)
  • .coderabbit.yaml
  • AGENTS.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Comment thread .coderabbit.yaml Outdated
Comment thread AGENTS.md
@ChristophWurst
ChristophWurst force-pushed the chore/coderabbit-config-from-review-history branch 2 times, most recently from 7d679e2 to 32c280f Compare August 31, 2026 15:40
@ChristophWurst

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@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: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2d893c60-9394-419c-84e4-3169edc1082a

📥 Commits

Reviewing files that changed from the base of the PR and between fdda8aa and 32c280f.

📒 Files selected for processing (2)
  • .coderabbit.yaml
  • AGENTS.md

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Comment thread .coderabbit.yaml Outdated
@ChristophWurst
ChristophWurst force-pushed the chore/coderabbit-config-from-review-history branch 3 times, most recently from 1d696a9 to 08c85b9 Compare August 31, 2026 16:58
@ChristophWurst

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@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

♻️ Duplicate comments (1)
AGENTS.md (1)

87-88: 📐 Maintainability & Code Quality | 🟡 Minor

Add blank lines after the new headings.

markdownlint-cli2 reports MD022 because each heading is followed immediately by list or paragraph content. Insert one blank line after each heading. This is the same issue reported in the previous review and reintroduced here.

Also applies to: 97-98, 131-132, 139-140, 158-159, 165-166, 187-188, 194-195, 199-200

Source: Linters/SAST tools


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 94ff2202-b8dc-4d3f-b3cf-3dce8afc9317

📥 Commits

Reviewing files that changed from the base of the PR and between 32c280f and 08c85b9.

📒 Files selected for processing (2)
  • .coderabbit.yaml
  • AGENTS.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Comment thread .coderabbit.yaml
Comment thread .coderabbit.yaml
@ChristophWurst

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown
⚠️ Action not completed

Already reviewed the last commit. Use @coderabbitai full review to rerun a review of the entire changeset.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@ChristophWurst

Copy link
Copy Markdown
Member Author

@coderabbitai full review before merge

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown

@ChristophWurst Full review requested for the complete changeset before merge.

✅ Action performed

Full review finished.

@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: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: ccfd6025-8894-432e-af5c-c6e3df27d0ce

📥 Commits

Reviewing files that changed from the base of the PR and between 2052ebb and 08c85b9.

📒 Files selected for processing (2)
  • .coderabbit.yaml
  • AGENTS.md

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Comment thread .coderabbit.yaml Outdated
Add an author-facing "Coding conventions" section to AGENTS.md and mirror
it per path in .coderabbit.yaml so contributors get the same feedback up
front that a review would raise, and reviews can focus on design.

The conventions are distilled from this repository's recurring review
remarks and the Nextcloud developer manual's coding standards. CodeRabbit
does not read AGENTS.md automatically, so the substance is repeated per
path; the two files are meant to be updated together.

Vendored code stays reviewable (only bundled/generated output is filtered)
so the bot can still look at human-relevant files such as composer.json.

Assisted-by: Claude Code:claude-opus-4-8
Signed-off-by: Christoph Wurst <1374172+ChristophWurst@users.noreply.github.com>
@ChristophWurst
ChristophWurst force-pushed the chore/coderabbit-config-from-review-history branch from 08c85b9 to 2c0675d Compare August 31, 2026 17:45
@ChristophWurst

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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

Labels

3. to review AI assisted This PR contains AI-assisted commits

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants