docs: AGENTS.md and AI-assisted contributing guidance - #5578
Conversation
✅ Deploy Preview for teslamate ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
The need for AGENTS.md is somewhat disputed at the moment. Does it speed things up? Or does it add stuff to the context window for every required request that could easily fall out of date and where the LLM could easily work out for itself? Haven't formed any definite opinions yet. Except sometimes the LLM might regularly get something wrong or take a long time to work out something, in which case that might be a good thing to document it. And some people are trying splitting the AGENTS.md up based on the task performed. In the case of this project, mentioning treefmt might be an example of something an LLM might miss. |
|
Thanks for write up Swiffer.
In my experience the only thing AI get sometimes only on second try is devenv up without TUI, which I want to solve with an inline comment. Other than that echoing Brian. |
|
Makes sense — happy to drop most of Open questions before I revise:
Happy to reshape heavily once that’s clearer. |
833c167 to
da8f8f5
Compare
Introduce lean agent guidance and document AI-assisted contributions (human remains responsible, exact model disclosure). Expand Grafana dashboard contributing notes (edge image, Classic export, units, variables, positions sampling).
da8f8f5 to
ae3d481
Compare
3 participants
Summary
Draft for discussion — not ready to merge as-is; looking for maintainer feedback on policy and wording.
This adds:
AGENTS.md: lean guidance for AI coding agents (setup/CI, Grafana conventions, security, AI disclosure footer).website/docs/development.mdx: human-facing § on AI-assisted contributions (welcome, but the person remains responsible) plus expanded Grafana dashboard notes (teslamate/grafana:edge, Classic model export not V2 Resource, variables/units, positions sampling).CONTRIBUTING: points agents atAGENTS.md.Call for review
@JakobLichterfeld and other maintainers — please treat this as a policy / docs RFC:
🤖 Assisted by <Exact model name> …) what we want project-wide?AGENTS.mdthe right home (vs only docs / vs tool-specific files)?Happy to revise heavily based on discussion before un-drafting.
Test plan
AGENTS.mdfor length and toneCONTRIBUTING→ docs /AGENTS.md) resolve as intended🤖 Assisted by Grok 4.5 (xAI) via Grok Build (planning, docs drafting, PR description).