Coderabbit instructions update

[nygrenh]

Summary by CodeRabbit

• Chores
  • Updated code review configuration with formatting improvements and enhanced guidance on comment best practices, including recommendations to avoid banner-style comments, prioritize comment quality, and maintain minimal function documentation while preserving meaningful existing comments.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Configuration file updated with comment guidance consolidation. Multi-line instruction collapsed into single line for brevity. New global guidance blocks added to system-tests and general paths ("**/*") emphasizing comment quality standards: avoiding banner-style comments, prioritizing meaningful commentary, ensuring minimal function documentation, and preserving existing valuable comments.

Changes

Cohort / File(s)	Summary
Configuration Guidance .coderabbit.yaml	Consolidated multi-line semantic selector instruction into single line; added duplicate global guidance blocks under **/* path rules covering comment standards (no banner comments, quality prioritization, minimal docs, preserve meaningful comments) in both system-tests and general contexts

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• Add .coderabbit.yaml configuration #1423: Also modifies .coderabbit.yaml configuration with system-tests path-specific guidance blocks

Suggested labels

docs

Poem

A comment, they say, should be true and be clear, 🐰
No banners of asterisks cluttering here,
Just meaningful words that illuminate well,
Preserve what is precious, drop what's trivial to tell! 📝

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Coderabbit instructions update' is directly related to the changeset, which consists entirely of updates to the .coderabbit.yaml configuration file with formatting changes and new guidance blocks.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

.coderabbit.yaml (1)

35-35: Consider keeping the multi-line format for better readability.

While functionally identical, the long single-line string may be harder to read and edit in the YAML file compared to the previous multi-line format using the > folded scalar style.

🔎 Alternative multi-line format

-        NEVER select elements by auto-generated CSS classes (e.g., `.locator(".css-xknul2-TopBar")`). Instead, use semantic selectors like data-testid attributes, role selectors, text content, or accessible names. Use `page.getByTestId()`, `page.getByRole()`, `page.getByText()`, or `page.getByLabel()` instead.
+        NEVER select elements by auto-generated CSS classes (e.g., `.locator(".css-xknul2-TopBar")`).
+        Instead, use semantic selectors like data-testid attributes, role selectors, text content, or accessible names.
+        Use `page.getByTestId()`, `page.getByRole()`, `page.getByText()`, or `page.getByLabel()` instead.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 92456c5 and 7cd3f9e.

📒 Files selected for processing (1)

• .coderabbit.yaml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: build-and-deploy
• GitHub Check: build-and-system-tests
• GitHub Check: headless_lms
• GitHub Check: code-style

🔇 Additional comments (2)

.coderabbit.yaml (2)

102-111: Well-structured global commenting guidelines.

The new commenting standards provide clear, actionable guidance with good examples. The four-part structure (avoid banners, prioritize quality, require minimal docs, protect existing comments) covers the key aspects of maintainable code comments.

A few observations:

• The **/* path applies these guidelines to all files, which is appropriate for organization-wide commenting standards
• The guidelines balance pragmatism (minimal but meaningful documentation) with flexibility (some functions may not need comments)
• Some guidance is inherently subjective (e.g., what constitutes "obvious" or "noise"), so reviewers should apply these principles with context and judgment

---

102-111: Inconsistency in AI-generated summary regarding duplicate blocks.

The AI summary mentions "Introduced a duplicate/new global guidance block under another '**/*' path," but only one **/* path instruction block is visible in the provided code (lines 102-111). If there was a duplicate, it's not present in the final version shown here.