Add generic tmt context to AGENTS.md#4585
Conversation
Summary of ChangesHello @happz, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request adds a comprehensive guide for AI assistants to the .claude/CLAUDE.md file. The guide provides a good overview of the tmt project, including its architecture, development commands, and coding standards. The information is largely accurate and will be very helpful. I've suggested one minor improvement to the 'Development Commands' section to correct the command for running tests and remove a redundancy.
123232e to
12fcda1
Compare
12fcda1 to
ec08df9
Compare
|
|
||
| - Unit tests should mock external dependencies | ||
| - Integration tests can use the container framework | ||
| - Follow existing test patterns in `tests/` directory |
There was a problem hiding this comment.
Too ambiguous for an AI. You are forcing the agent to guess which file represents your gold standard.
Give it a specific anchor. Change this to: "Follow existing test patterns (e.g., refer to tests/prepare/install)"
There was a problem hiding this comment.
/tests/prepare/install probably because it has the context of running on multiple images.
| - Security-focused linting with bandit checks provided by ruff | ||
|
|
||
|
|
||
| ## Release Notes Generation |
There was a problem hiding this comment.
if you load this entire AGENTS.md file into your AI's context every time you start a chat, you are forcing the AI to read and "remember" how to format release notes even when you just want it to help you debug a unit test in tmt/steps/provision. So this should be moved to a seprate file.
There was a problem hiding this comment.
Which file then? If these are instructions for an agent which shall be in the AGENTS.md file, where should we put instructions that are supposed to be read by an agent, but only in some situations?
There was a problem hiding this comment.
I'd suggest moving the actual release note instructions into a dedicated file, something like docs/agents/release-notes-prompt.md or somewhere else.
What you keep in AGENTS.md is just a pointer to that new file. You could add a simple rule in AGENTS.md that says something like:
If the task involves generating release notes,
load and follow the instructions in docs/agents/release-notes-prompt.md.This way, AGENTS.md stays lean and acts as a router. The heavy, specific formatting instructions are only loaded into the AI's context when release note generation is explicitly requested. If a developer is just asking the AI to debug a unit test, those extra instructions are ignored, keeping the AI focused entirely on the code.
@thrix is there anything better we could do here?
There was a problem hiding this comment.
something like
docs/agents/release-notes-prompt.mdor somewhere else.
Can we please not contaminate other directories with machine language
There was a problem hiding this comment.
What do you suggest then as an alternative? Keeping everything related to agents in a single huge file? That does not seem to be very maintainable to me. Having a dedicated folder for agent skills where each area would have its only file sounds reasonable to me. If we agree on the specific location there will not be any "contamination" with other docs.
There was a problem hiding this comment.
What do you suggest then as an alternative? Keeping everything related to agents in a single huge file? That does not seem to be very maintainable to me.
The thing is not human readable/maintainable from the beginning IMO.
Having a dedicated folder for agent skills where each area would have its only file sounds reasonable to me.
Yes, a dedicated folder would be preferred.
There was a problem hiding this comment.
Yes, let's keep assistant instructions separated from user-focused documentation. Moved in 0b73a5f.
ec08df9 to
cd34663
Compare
|
|
||
| 7. **Review**: Ensure all significant changes for the milestone are covered and the formatting matches the existing style in the `docs/releases/` directory. | ||
|
|
||
| ## Using This Instruction with Different AI Tools |
There was a problem hiding this comment.
This section and the following ones (MCP Setup and Custom Instructions) are human-oriented documentation, not an interesting reading for agents, let's move them to the contribute page.
|
|
||
| ## Overview | ||
|
|
||
| TMT (Test Management Tool) is a comprehensive Python-based testing framework that provides |
There was a problem hiding this comment.
| TMT (Test Management Tool) is a comprehensive Python-based testing framework that provides | |
| tmt (Test Management Tool) is a comprehensive Python-based testing framework that provides |
tmt and fmf should be always written in lower-case, except for envvar, class and similar exceptions...
1754050 to
6e44ff1
Compare
6e44ff1 to
0b73a5f
Compare
And AGENTS.md is born from Claude instructions. This way we should cover other agents as well as Claude.
Pull Request Checklist