← Back to issue list

Add `AGENTS.md` to templates

View original Github issue

Metadata

Project
charmcraft
Number
#2443
Type
issue
State
open
Author
sed-i
Labels
Status: Needs information Type: Enhancement
Created
Updated
Closed
—

Current evaluation

Enhancement request to add AGENTS.md agentic-coding instructions to charmcraft init templates. Under discussion; maintainers seek a concrete generic example to adapt.

Suggested action: keep open

Reason: The issue is a valid, maintainer-engaged enhancement carrying the 'Status: Needs information' label; @dimaqq's comment ('if you have a charm with good AGENTS.md, we can copy that over and trim it down') shows it is waiting on a concrete generic example rather than being resolved or rejected. Existing AGENTS.md templates in starbase#543 and craft-application#1209 provide ready material to adapt once that example lands.

Evaluated by: mr-cal-bot

Impact: 35 Quick Win: 10 Complexity: 35 Confidence: 60 Actionability: 45

Issue body

### What needs to get done Come up with a set of instructions for agentic coding. Refs: - https://agents.md/ - https://claudecode.io/tutorials/claude-md-setup - AGENTS.md files on github - [query](https://github.com/search?q=path%3A**%2FAGENTS.md&type=code) ### Why it needs to get done To enable more productive agentic coding.

Evaluation history

Date Model Scores Action Summary
~deepseek/deepseek-pro-latest
Impact: 35
Quick Win: 10
Complexity: 35
Confidence: 60
Actionability: 45
keep open Enhancement request to add AGENTS.md agentic-coding instructions to charmcraft init templates. Under discussion; maintainers seek a concrete generic example to adapt.
~deepseek/deepseek-pro-latest
Impact: 35
Quick Win: 7
Complexity: 45
Confidence: 70
Actionability: 35
keep open Enhancement request to add AGENTS.md agentic coding instructions to charmcraft init templates. Under discussion; maintainers seek a concrete generic example to adapt.
qwen/qwen3.6-35b-a3b
Impact: 35
Quick Win: 16
Complexity: 25
Confidence: 70
Actionability: 60
keep open Enhancement to add AGENTS.md template for agentic coding support. Maintainers engaged, awaiting concrete proposal on content scope.
qwen/qwen3.8-27b
Impact: 25
Quick Win: 16
Staleness: 72
Complexity: 35
Confidence: 78
Support Request: 5
close stale Enhancement request to add AGENTS.md (agentic coding instructions) to charmcraft init templates. Labeled Needs information; maintainer asked the author for a concrete example in Jan 2026, no response for over 6 months; no template changes made.
qwen/qwen3.6-35b-a3b
Staleness: 65
Complexity: 20
Confidence: 85
Support Request: 10
keep open Request to add a generic AGENTS.md file to project templates to improve agentic LLM coding workflows. Maintainers are discussing standardization and suggest adapting an existing charm's file.
qwen3.6-35b-a3b-mtp-q6
Staleness: 60
Complexity: 25
Confidence: 80
Support Request: 5
keep open Enhancement request to add a generic AGENTS.md file to project templates for agentic coding. Currently under discussion with maintainers, awaiting a concrete template draft or sprint planning.
qwen3.6-35b-a3b-mtp-q6
Staleness: 60
Complexity: 20
Confidence: 85
Support Request: 0
keep open Enhancement request to add a generic AGENTS.md template for agentic coding. Maintainers discussed utility and suggested drafting a trimmed version. Currently awaiting author input or sprint discussion.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/starbase#543 (confidence 80%)

    Merged PR adding AGENTS.md templates for Craft apps and libraries — a likely source to adapt for charmcraft templates.

  • Related To: canonical/craft-application#1209 (confidence 75%)

    Merged PR adding an AGENTS.md derived from Starbase's template, showing the pattern has already been applied in a sibling Craft project.

Related issues

Issue Project State Summary Similarity
#1023 docs: add AGENTS.md for craft-providers craft-providers merged Merged PR #1023 adding an AGENTS.md file to the craft-providers repository, derived from the Starbase template and adapted to follow the craft-cli precedent.
75%
#494 docs: add AGENTS.md instructions for craft-cli craft-cli merged Merged PR #494 adding AGENTS.md instructions for AI coding agents, adapted from the Starbase template.
75%
#1209 docs: add AGENTS.md for AI coding assistants craft-application merged Merged PR adding a 99-line AGENTS.md for AI coding assistants, derived from Starbase's AGENTS.lib.md template and customized for craft-application. Supersedes stale draft #954.
74%
#543 feat: add agents files starbase merged Merged PR #543 in commit 2cf6c9a, adding AGENTS.md templates for Craft apps and libraries and a repository-level AGENTS.md.
70%