Vibe: Adding agents.md when scaffolding panel plugin

[mckn]

What this PR does / why we need it: It will add a agents.md file that cover the fundamentals of panel plugins. We are keeping the convention where we put generic information below .config folder (which should not be modified by the developer). Then we reference that file from the project AGENTS.md where the developers can add more project specific details.

Which issue(s) this PR fixes:

Fixes https://github.com/grafana/grafana-community-team/issues/673

Special notes for your reviewer:

📦 Published PR as canary version: Canary Versions

:sparkles: Test out this PR locally via:

npm install @grafana/[email protected]
# or 
yarn add @grafana/[email protected]

[github-actions[bot]]

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged and will trigger a new minor release. NOTE: When merging a PR with the release label please avoid merging another PR. For further information see here.

[mckn]

Nice! ✨

I was looking at some examples of agent files, and it seems to be a common pattern to list and describe all available commands early in the file. Even though the frontend scripts are specified in package.json and are mostly self-explanatory, it's not entirely obvious that one needs to have a server running before, for example, running the e2e tests.

Great feedback! What do you think about adding a line saying something like: "Follow the instructions in the readme for how to run and test the plugin".

Regarding commands. What do you think about adding a line saying something like: "For available commands please look in the package.json" (for other plugins we also need to include the mage commands). Alternatively we can generate the list of commands in the root agents.md file. The only thing I'm a bit worried about is that file getting out of sync with the actual package.json file.

[sunker]

Great feedback! What do you think about adding a line saying something like: "Follow the instructions in the readme for how to run and test the plugin".

Regarding commands. What do you think about adding a line saying something like: "For available commands please look in the package.json" (for other plugins we also need to include the mage commands). Alternatively we can generate the list of commands in the root agents.md file. The only thing I'm a bit worried about is that file getting out of sync with the actual package.json file.

Referring to the "Get started" section in the readme feels like a good starting point. 👍

[grafana-plugins-platform-bot[bot]]

:rocket: PR was released in @grafana/[email protected] :rocket: