Skip to content

Conversation

@planetf1
Copy link

@planetf1 planetf1 commented Jan 16, 2026

Misc PR

Type of PR

  • Bug Fix
  • New Feature
  • Documentation
  • Other

Description

Adds structured guidance for AI coding assistants (Claude Code, Cursor, Copilot, etc.) working with Mellea.

Closes #319

What's included

  • AGENTS.md - Guidelines for contributors modifying Mellea internals (test markers, coding standards, common issues)
  • docs/AGENTS_TEMPLATE.md - Template that downstream projects can copy when building apps with Mellea

Why

AI assistants without guidance could produce code that doesn't follow project patterns. This follows the emerging AGENTS.md convention (https://docs.anthropic.com/en/docs/claude-code/memory#agentsmd).

Feedback welcome on what to add, remove, or clarify. I missed the statement about getting comments on issue first - apologies. I'm sure the dev team will have feedback on the rules, which I built from best practice/previous projects & what I've experienced with mellea over a few days using it. I do think it's important we get something to guide towards consistency?

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code as added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

Add structured guidance for AI assistants working with Mellea:
- AGENTS.md for contributors modifying Mellea internals
- docs/AGENTS_TEMPLATE.md for downstream projects to copy
@github-actions
Copy link
Contributor

The PR description has been updated. Please fill out the template for your PR to be reviewed.

@mergify
Copy link

mergify bot commented Jan 16, 2026

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release)(?:\(.+\))?:

@planetf1 planetf1 marked this pull request as ready for review January 16, 2026 13:59
@planetf1 planetf1 changed the title Add AGENTS.md to guide AI coding assistants docs: Add AGENTS.md to guide AI coding assistants Jan 16, 2026
@nrfulton
Copy link
Contributor

I missed the statement about getting comments on issue first - apologies.

No worries!

I'm sure the dev team will have feedback on the rules, which I built from best practice/previous projects & what I've experienced with mellea over a few days using it. I do think it's important we get something to guide towards consistency?

I haven't thought deeply about a generic Mellea AGENTS.md; I normally write a separate one for each major project I'm working on. But having a generic AGENTS definitely makes sense.

I'll bring this up in our leads today. I think there are two paths:

  1. Do it right the first time. That probably creates some iteration on this PR.
  2. Just add something to get started and let the community iterate. Then we'd probably just merge this PR soon with the expectation of future iteration.

- Use uv sync --all-extras --all-groups (required for tests)
- Add ollama serve requirement
- Remove non-existent integration marker
- Fix test timing expectations (~2 min, not instant)
- Remove contradictory unmarked test guidance
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.

Add AGENTS.md to guide AI coding assistants

2 participants