chore: Setup AI agent infrastructure - #202
Conversation
- Add .agents/AGENTS.md: AI contributor guide with project overview and crate map - Add .agents/CONTRIBUTING_AGENTS.md: research-backed governance guide for editing AGENTS.md - Update .gitignore: track AGENTS.md and CONTRIBUTING_AGENTS.md, ignore rest of .agents/ and .opencode
|
@coderabbitai full review |
✅ Action performedFull review finished. |
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughAdds ChangesAgent guidance and repository tracking
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 @.agents/AGENTS.md:
- Around line 7-27: Fix the overview table in AGENTS.md so its structure is
consistent: either add a meaningful Description cell to every area row, or
remove the Description column from the header and separator. Preserve all
existing area names and locations.
In @.agents/CONTRIBUTING_AGENTS.md:
- Around line 8-20: Update the Table of Contents anchors in
CONTRIBUTING_AGENTS.md to match the generated heading IDs, including
emoji-prefixed IDs and the full “Sub-Agent Usage and Setup Guidelines” heading.
Correct all affected entries, including the anchors for Why This File Exists,
Research Findings, Contributor Conclusions, Sub-Agent Usage, and Note to
Maintainers, so markdownlint MD051 passes.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro Plus
Run ID: ac98ef57-6a66-4398-baca-fda4c8c6dae0
📒 Files selected for processing (3)
.agents/AGENTS.md.agents/CONTRIBUTING_AGENTS.md.gitignore
📜 Review details
🧰 Additional context used
🪛 LanguageTool
.agents/AGENTS.md
[uncategorized] ~27-~27: The official name of this software platform is spelled with a capital “H”.
Context: ...ackaging/| | CI/CD (GitHub Actions) |.github/` |
(GITHUB)
.agents/CONTRIBUTING_AGENTS.md
[style] ~38-~38: Consider shortening or rephrasing this to strengthen your wording.
Context: ...earch Findings > [!IMPORTANT] > Before making changes to the AGENTS.md fil...
(MAKE_CHANGES)
[grammar] ~64-~64: Use a hyphen to join words.
Context: ...le files function primarily as a context priming signal that activates structured...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.23.1)
.agents/AGENTS.md
[warning] 9-9: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 10-10: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 11-11: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 12-12: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 13-13: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 14-14: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 15-15: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 16-16: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 17-17: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 18-18: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 19-19: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 20-20: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 21-21: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 22-22: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 23-23: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 24-24: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 25-25: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 26-26: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 27-27: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
.agents/CONTRIBUTING_AGENTS.md
[warning] 10-10: Link fragments should be valid
(MD051, link-fragments)
[warning] 11-11: Link fragments should be valid
(MD051, link-fragments)
[warning] 16-16: Link fragments should be valid
(MD051, link-fragments)
[warning] 17-17: Link fragments should be valid
(MD051, link-fragments)
[warning] 20-20: Link fragments should be valid
(MD051, link-fragments)
🔇 Additional comments (1)
.gitignore (1)
28-33: LGTM!
| | Area | Location | Description | | ||
| |------|----------|-------------| | ||
| | asus-shutdown | `asus-shutdown/` | | ||
| | asusctl (CLI) | `asusctl/` | | ||
| | asusd (system D-Bus daemon) | `asusd/` | | ||
| | asusd-user (user D-Bus daemon) | `asusd-user/` | | ||
| | config-traits | `config-traits/` | | ||
| | dmi-id | `dmi-id/` | | ||
| | rog-platform | `rog-platform/` | | ||
| | rog-dbus | `rog-dbus/` | | ||
| | rog-anime | `rog-anime/` | | ||
| | rog-aura | `rog-aura/` | | ||
| | rog-profiles | `rog-profiles/` | | ||
| | rog-control-center | `rog-control-center/` | | ||
| | rog-slash | `rog-slash/` | | ||
| | rog-scsi | `rog-scsi/` | | ||
| | simulators | `simulators/` | | ||
| | data (service files, udev rules) | `data/` | | ||
| | extra (icons, web assets) | `extra/` | | ||
| | distro-packaging | `distro-packaging/` | | ||
| | CI/CD (GitHub Actions) | `.github/` | No newline at end of file |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the malformed overview table.
The header declares three columns, but every data row has only two cells, so the Description column is missing. Add a description to each row or remove that column from the header and separator.
Proposed minimal fix
-| Area | Location | Description |
-|------|----------|-------------|
+| Area | Location |
+|------|----------|📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Area | Location | Description | | |
| |------|----------|-------------| | |
| | asus-shutdown | `asus-shutdown/` | | |
| | asusctl (CLI) | `asusctl/` | | |
| | asusd (system D-Bus daemon) | `asusd/` | | |
| | asusd-user (user D-Bus daemon) | `asusd-user/` | | |
| | config-traits | `config-traits/` | | |
| | dmi-id | `dmi-id/` | | |
| | rog-platform | `rog-platform/` | | |
| | rog-dbus | `rog-dbus/` | | |
| | rog-anime | `rog-anime/` | | |
| | rog-aura | `rog-aura/` | | |
| | rog-profiles | `rog-profiles/` | | |
| | rog-control-center | `rog-control-center/` | | |
| | rog-slash | `rog-slash/` | | |
| | rog-scsi | `rog-scsi/` | | |
| | simulators | `simulators/` | | |
| | data (service files, udev rules) | `data/` | | |
| | extra (icons, web assets) | `extra/` | | |
| | distro-packaging | `distro-packaging/` | | |
| | CI/CD (GitHub Actions) | `.github/` | | |
| | Area | Location | | |
| |------|----------| | |
| | asus-shutdown | `asus-shutdown/` | | |
| | asusctl (CLI) | `asusctl/` | | |
| | asusd (system D-Bus daemon) | `asusd/` | | |
| | asusd-user (user D-Bus daemon) | `asusd-user/` | | |
| | config-traits | `config-traits/` | | |
| | dmi-id | `dmi-id/` | | |
| | rog-platform | `rog-platform/` | | |
| | rog-dbus | `rog-dbus/` | | |
| | rog-anime | `rog-anime/` | | |
| | rog-aura | `rog-aura/` | | |
| | rog-profiles | `rog-profiles/` | | |
| | rog-control-center | `rog-control-center/` | | |
| | rog-slash | `rog-slash/` | | |
| | rog-scsi | `rog-scsi/` | | |
| | simulators | `simulators/` | | |
| | data (service files, udev rules) | `data/` | | |
| | extra (icons, web assets) | `extra/` | | |
| | distro-packaging | `distro-packaging/` | | |
| | CI/CD (GitHub Actions) | `.github/` | |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: The official name of this software platform is spelled with a capital “H”.
Context: ...ackaging/| | CI/CD (GitHub Actions) |.github/` |
(GITHUB)
🪛 markdownlint-cli2 (0.23.1)
[warning] 9-9: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 10-10: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 11-11: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 12-12: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 13-13: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 14-14: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 15-15: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 16-16: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 17-17: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 18-18: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 19-19: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 20-20: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 21-21: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 22-22: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 23-23: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 24-24: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 25-25: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 26-26: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 27-27: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
🤖 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 @.agents/AGENTS.md around lines 7 - 27, Fix the overview table in AGENTS.md
so its structure is consistent: either add a meaningful Description cell to
every area row, or remove the Description column from the header and separator.
Preserve all existing area names and locations.
Source: Linters/SAST tools
| ## 📋 Table of Contents | ||
|
|
||
| 1. [Why This File Exists](#why-this-file-exists) | ||
| 2. [Research Findings](#research-findings) | ||
| - [1. Instruction File Structure & Impact (Instructions-as-Code)](#1-instruction-file-structure--impact-instructions-as-code) | ||
| - [2. Rule Polarity & Context Priming (Guardrails vs. Guidance)](#2-rule-polarity--context-priming-guardrails-vs-guidance) | ||
| - [3. Repository Context Overhead & Minimalist Design (AGENTS.md Evaluation)](#3-repository-context-overhead--minimalist-design-agentsmd-evaluation) | ||
| - [4. Closed-Loop Review Feedback & Behavioral Rule Accumulation (Self-Improving Agents)](#4-closed-loop-review-feedback--behavioral-rule-accumulation-self-improving-agents) | ||
| 3. [Contributor Conclusions](#contributor-conclusions) | ||
| - [Sub-Agent Usage](#sub-agent-usage) | ||
| - [Performance and Flow Configuration](#performance-and-flow-configuration) | ||
| - [Documentation File Method](#documentation-file-method) | ||
| 4. [Note to Maintainers: AI Feedback Loop](#note-to-maintainers-ai-feedback-loop) |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the broken table-of-contents anchors.
These entries do not resolve to their headings. Update them to match the generated heading IDs, including the emoji-prefixed headings and the full Sub-Agent Usage and Setup Guidelines heading—for example, #-why-this-file-exists, #-research-findings, #-contributor-conclusions, #sub-agent-usage-and-setup-guidelines, and #-note-to-maintainers-ai-feedback-loop.
markdownlint reports these as MD051 link-fragment errors.
🧰 Tools
🪛 markdownlint-cli2 (0.23.1)
[warning] 10-10: Link fragments should be valid
(MD051, link-fragments)
[warning] 11-11: Link fragments should be valid
(MD051, link-fragments)
[warning] 16-16: Link fragments should be valid
(MD051, link-fragments)
[warning] 17-17: Link fragments should be valid
(MD051, link-fragments)
[warning] 20-20: Link fragments should be valid
(MD051, link-fragments)
🤖 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 @.agents/CONTRIBUTING_AGENTS.md around lines 8 - 20, Update the Table of
Contents anchors in CONTRIBUTING_AGENTS.md to match the generated heading IDs,
including emoji-prefixed IDs and the full “Sub-Agent Usage and Setup Guidelines”
heading. Correct all affected entries, including the anchors for Why This File
Exists, Research Findings, Contributor Conclusions, Sub-Agent Usage, and Note to
Maintainers, so markdownlint MD051 passes.
Source: Linters/SAST tools
- Relocate .agents/AGENTS.md to the repo root (AGENTS.md standard) - Populate the overview table descriptions and add a "What not to do" rule - Fix CONTRIBUTING_AGENTS.md TOC anchors (MD051) and point AGENTS.md links to /AGENTS.md - Drop the obsolete .agents/AGENTS.md negation from .gitignore
be288cb to
846c335
Compare
|
If you are interested these are the rules I had set to my AI. If you think any of these can be of help feel fre to pick them up Asusctl Repository & Agent Governance RulesThis document outlines the strict guidelines, coding standards, daemon architecture rules, safety constraints, and Git workflow policies required when working on the Important Core Principle: Code quality, memory safety, and daemon stability ALWAYS take absolute precedence over implementation speed or temporary workarounds. Every change must be robust, production-grade, and empirical-verified. 1. Git & Workflow Guidelines1.1. Never Bypass Git Hooks
1.2. Explicit Push Authorization
1.3. Clean Local ChecksBefore creating any commit, the codebase must pass all local verification checks specified in Section 5.1 with zero errors and zero warnings. Important Every single commit must maintain flawless formatting and zero warnings across all workspace crates. 1.4. Atomic Commits & Standardized Commit Messages
2. Rust Safety & Code Quality Rules2.1. Prohibition of
|
3 participants
Summary
This PR introduces comprehensive AI agent support infrastructure for the asusctl project. To streamline AI-assisted development workflows across modern agentic tools (Claude, Cursor, OpenCode, Antigravity, etc.), it establishes the standard .agents/ workspace directory, sub-agents, and skill files.
Roadmap
Summary by CodeRabbit
Documentation
Chores