Skip to content

Add AGENTS.md maintenance protocol and Dashboards/QAN component guides#5226

Open
ondrejpatocka wants to merge 2 commits intov3from
PMM-7-AI-Agents-optimization
Open

Add AGENTS.md maintenance protocol and Dashboards/QAN component guides#5226
ondrejpatocka wants to merge 2 commits intov3from
PMM-7-AI-Agents-optimization

Conversation

@ondrejpatocka
Copy link
Copy Markdown
Contributor

@ondrejpatocka ondrejpatocka commented Apr 8, 2026

Summary

  • Add a "Maintaining This Document" section to AGENTS.md that instructs AI agents
    to review and update the file whenever they make structural changes (new components,
    tech stack changes, convention changes, etc.)
  • Add component guides for Grafana dashboards (dashboards.instructions.md) and the
    QAN Grafana plugin (qan-app.instructions.md)
  • Register both new guides in the AGENTS.md component tables
  • Remove the stale percona/grafana-dashboards external repo reference (dashboards
    now live in-repo under dashboards/)

@ondrejpatocka ondrejpatocka self-assigned this Apr 8, 2026
@ondrejpatocka ondrejpatocka requested a review from a team as a code owner April 8, 2026 13:45
@ondrejpatocka ondrejpatocka requested review from JiriCtvrtka, ademidoff, fabio-silva, matejkubinec and maxkondr and removed request for a team April 8, 2026 13:45
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47.79%. Comparing base (38c9b56) to head (c20571b).
⚠️ Report is 4 commits behind head on v3.

Additional details and impacted files
@@           Coverage Diff           @@
##               v3    #5226   +/-   ##
=======================================
  Coverage   47.79%   47.79%           
=======================================
  Files         410      410           
  Lines       41981    41981           
=======================================
  Hits        20066    20066           
+ Misses      19940    19939    -1     
- Partials     1975     1976    +1     
Flag Coverage Δ
admin 35.80% <ø> (ø)
agent 53.36% <ø> (+0.01%) ⬆️
managed 47.71% <ø> (-0.01%) ⬇️
vmproxy 72.09% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

AGENTS.md Outdated
Component-specific guides:
- .github/instructions/<component>.instructions.md (GitHub Copilot applyTo scoping)
Last reviewed: 2026-03 -->
Last reviewed: 2026-04 -->
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

That whole comment is consuming tokens and is mostly irrelevant. One can easily figure out the revision date by the file timestamp.

As a general rule, we'd better keep such files tiny than fat. Letting AI figure it out is the best advice one can get nowadays :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good catch, removed!
Makes sense to make Agents.md file as much accurate and condensed as we can (better to remove anything not relevant / not important / misleading).

- remove the commented notes to shorten the file
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.

3 participants