Skip to content

feat: add agents files#543

Open
mr-cal wants to merge 5 commits into
mainfrom
work/CRAFT-5188/agents
Open

feat: add agents files#543
mr-cal wants to merge 5 commits into
mainfrom
work/CRAFT-5188/agents

Conversation

@mr-cal
Copy link
Copy Markdown
Collaborator

@mr-cal mr-cal commented Jun 3, 2026

Adds an:

  • Agents template for craft apps
  • Agents template for craft libraries
  • Agents file for starbase itself

Sources used:

  • Evaluating AGENTS.md: Are Repository-Level Context Files Helpful for Coding Agents? (source)
  • On the Impact of AGENTS.md Files on the Efficiency of AI Coding Agents (source)
  • Prompting best practices from the Claude API docs (source)
  • https://agents.md/
    • This is the official standard for agents files. It covers the file name, loosely covers file discovery, and doesn't really cover file contents.

(CRAFT-5188)


  • I've followed the contribution guidelines.
  • I've signed the CLA.
  • I've successfully run make lint && make test.
  • I've added or updated any relevant documentation.
  • In documents I changed, I added a meta description if one was missing.
  • I've updated the relevant release notes.

Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
Copilot AI review requested due to automatic review settings June 3, 2026 16:54
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds repository-level agent context (AGENTS.md) plus two reusable agent-file templates for downstream Craft apps and libraries, and updates the project template checklist to reference them.

Changes:

  • Added AGENTS.md describing Starbase context, development commands, and contribution practices for coding agents.
  • Added AGENTS.app.md and AGENTS.lib.md templates for downstream Craft apps/libraries to customize and rename to AGENTS.md.
  • Updated .github/README.md “Create a new project” checklist to include the new agents template step and cleanup instruction.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 7 comments.

File Description
AGENTS.md Adds Starbase-specific agent context and common dev/test/lint commands.
AGENTS.app.md Provides an app-focused AGENTS template for Craft Application-based CLIs.
AGENTS.lib.md Provides a library-focused AGENTS template for craft libraries.
.github/README.md Updates new-project checklist to incorporate the agents templates and cleanup steps.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.app.md Outdated
Comment thread AGENTS.app.md Outdated
Comment thread AGENTS.app.md Outdated
Comment thread AGENTS.lib.md Outdated
Comment thread AGENTS.lib.md Outdated
Comment thread AGENTS.lib.md Outdated
mr-cal added 2 commits June 3, 2026 12:36
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal
Copy link
Copy Markdown
Collaborator Author

mr-cal commented Jun 3, 2026

RTD failure unrelated

@mr-cal mr-cal marked this pull request as ready for review June 3, 2026 18:00
@mr-cal mr-cal requested review from cmatsuoka and lengau June 3, 2026 19:04
Comment thread AGENTS.app.md
Comment thread AGENTS.app.md Outdated
Comment thread AGENTS.md

The source code for these projects is at https://github.com/canonical/<project>.

Repos that use starbase track it as a git remote named `starbase` and periodically merge
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Out of scope, but a "merge starbase" skill would be really cool.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Agreed! We can mention the canonical/copilot-collections#43 skill when it lands.

mr-cal added 2 commits June 4, 2026 07:46
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal mr-cal requested a review from lengau June 4, 2026 12:51
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