PMM-7 - Add AI agents development guide#892
Draft
ondrejpatocka wants to merge 1 commit into
Draft
Conversation
788486f to
4555582
Compare
Collaborator
|
@ondrejpatocka since grafana has their own agents.md, I think it would be good to have a |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AGENTS.md— a comprehensive development guide for AI coding agents, documenting the Percona/PMM delta over upstream Grafana (architecture, directory structure, state management, API layer, conventions, configuration, dev workflow, and testing).CLAUDE.md— Claude Code auto-discovery.cursorrules— Cursor auto-discovery.github/copilot-instructions.md— GitHub Copilot auto-discoveryAGENTS.mdwhenever they add or change PMM features, routes, plugins, Redux slices, API services, CI configs, or environment variables — preventing the guide from going stale over time.Motivation
AI agents (Claude Code, Cursor, GitHub Copilot, etc.) lack awareness of the Percona fork's conventions, integration points, and
// @PERCONAtagging discipline. Without explicit guidance they tend to scatter PMM code across upstream Grafana directories, miss existing API patterns, or break rebase-friendly conventions. A single authoritative document — automatically loaded by each tool — gives every agent session the right context from the start.What's included
AGENTS.mdCLAUDE.mdAGENTS.md, repeats PMM context.cursorrulesAGENTS.md, repeats PMM context.github/copilot-instructions.mdAGENTS.md, repeats PMM context