Skip to content

chore(AGENTS.md): avoid by default adoption of agentic conventions#7177

Open
d3flex wants to merge 1 commit intoos-autoinst:masterfrom
d3flex:feat/agents_as_template
Open

chore(AGENTS.md): avoid by default adoption of agentic conventions#7177
d3flex wants to merge 1 commit intoos-autoinst:masterfrom
d3flex:feat/agents_as_template

Conversation

@d3flex
Copy link
Copy Markdown
Contributor

@d3flex d3flex commented Mar 24, 2026

There are many reasons to not enforce use of AGENTS.md by default Here some of them:

  • let the user decide whether to use AI coding assistants at all
  • user might already have his/her own one
  • avoids conflicts
  • maintainance (prevent outdated conventions)
  • keeps the repo free of tooling-specific

There are many reasons to not enforce use of AGENTS.md by default
Here some of them:
- let the user decide whether to use AI coding assistants at all
- user might already have his/her own one
- avoids conflicts
- maintainance (prevent outdated conventions)
- keeps the repo free of tooling-specific

Signed-off-by: Ioannis Bonatakis <ybonatakis@suse.com>
@github-actions
Copy link
Copy Markdown

Great PR! Please pay attention to the following items before merging:

Files matching docs/*.asciidoc:

This is an automatically generated QA checklist based on modified files.

Copy link
Copy Markdown
Member

@okurz okurz left a comment

Choose a reason for hiding this comment

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

You can always combine personal preferences by putting them into local and home folder AGENTS.md, no need to disable the project one. If you see certain guidelines not generally applicable please address those specifically, don't move the whole file

@d3flex
Copy link
Copy Markdown
Contributor Author

d3flex commented Mar 24, 2026

You can always combine personal preferences by putting them into local and home folder AGENTS.md, no need to disable the project one. If you see certain guidelines not generally applicable please address those specifically, don't move the whole file

But applies to the project and the user should have the free choice to decide whether to use it or not. There are also possible side effects and the rational approach is to not "enable" it by default. As a team member I have to remove it and makes my work unnecessarily harder

@okurz
Copy link
Copy Markdown
Member

okurz commented Mar 24, 2026

You can always combine personal preferences by putting them into local and home folder AGENTS.md, no need to disable the project one. If you see certain guidelines not generally applicable please address those specifically, don't move the whole file

But applies to the project and the user should have the free choice to decide whether to use it or not. There are also possible side effects and the rational approach is to not "enable" it by default. As a team member I have to remove it and makes my work unnecessarily harder

I’d like to understand the side effects you're running into. Since AGENTS.md is just a passive text file, it shouldn't interfere with standard development workflows.
If you are using an AI assistant that automatically picks this up and it's causing friction, could you share what's going wrong? The goal of the file is to teach AI tools our existing project conventions (like running make tidy, conventional commits, etc.). If specific instructions in the file are making your work harder, we should absolutely fix or remove those specific instructions.
If you simply prefer your AI to not use these project guidelines at all, most tools support ignoring specific files (e.g., via an ignore file or tool settings) so you wouldn't need to manually delete it and dirty your local git tree.
Having it in the root by default is valuable because it provides an immediate newcomer helping solution for AI tools to produce code that matches openQA's standards, without requiring manual template setup from every contributor. Moving it to a template defeats the purpose of having a repository standard, as it requires opt-in manual setup before the AI behaves correctly.
It feels like (again) you want to object just for the sake of it and not based on actual problems. However still there are ways to ignore the file if for any reason you see the need. https://opencode.ai/docs/rules/#initialize suggests clearly "You should commit your project’s AGENTS.md file to Git.". You can still remove the file and mention it in .git/info/exclude. Also, anomalyco/opencode#17990 is a feature request for opencode which could offer what you ask for.

@d3flex
Copy link
Copy Markdown
Contributor Author

d3flex commented Mar 25, 2026

You can always combine personal preferences by putting them into local and home folder AGENTS.md, no need to disable the project one. If you see certain guidelines not generally applicable please address those specifically, don't move the whole file

But applies to the project and the user should have the free choice to decide whether to use it or not. There are also possible side effects and the rational approach is to not "enable" it by default. As a team member I have to remove it and makes my work unnecessarily harder

I’d like to understand the side effects you're running into. Since AGENTS.md is just a passive text file, it shouldn't interfere with standard development workflows. If you are using an AI assistant that automatically picks this up and it's causing friction, could you share what's going wrong? The goal of the file is to teach AI tools our existing project conventions (like running make tidy, conventional commits, etc.). If specific instructions in the file are making your work harder, we should absolutely fix or remove those specific instructions. If you simply prefer your AI to not use these project guidelines at all, most tools support ignoring specific files (e.g., via an ignore file or tool settings) so you wouldn't need to manually delete it and dirty your local git tree. Having it in the root by default is valuable because it provides an immediate newcomer helping solution for AI tools to produce code that matches openQA's standards, without requiring manual template setup from every contributor. Moving it to a template defeats the purpose of having a repository standard, as it requires opt-in manual setup before the AI behaves correctly. It feels like (again) you want to object just for the sake of it and not based on actual problems. However still there are ways to ignore the file if for any reason you see the need. https://opencode.ai/docs/rules/#initialize suggests clearly "You should commit your project’s AGENTS.md file to Git.". You can still remove the file and mention it in .git/info/exclude. Also, anomalyco/opencode#17990 is a feature request for opencode which could offer what you ask for.

it doesnt affect me personally and directly. My objection is that the project should not enable those capabilities by default. There are cases where I think we cant predict where this will be used and as an open source project should let the user decide if he wants it or not. As is now is opt-in by default. I list a few additional reasons in the commit. What might left out of it is exactly what it is not predictable and out of our control. it gives to any tooling to use it without us knowing now or in the future. So see my concern not as an objection about any specific instruction being wrong, which the content might be fine, but about this default opt-in behavior. Having it in the root means every contributor using an AI assistant gets the project's conventions injected automatically, whether they want them or not. isnt that some sort of inversion of the control and the opposite of what open source advocate?
What I propose doesn't remove the value for newcomers you want because they can still copy the template in 30 seconds. I list a few additional reasons in the commit.

@okurz
Copy link
Copy Markdown
Member

okurz commented Mar 25, 2026

it doesnt affect me personally and directly. My objection is that the project should not enable those capabilities by default.

And I tried to explain why the very miniature set of rules included in the current AGENTS.md should be enabled by default.

Copy link
Copy Markdown
Contributor

@Martchus Martchus left a comment

Choose a reason for hiding this comment

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

To me this specific AGENTS.md file looks like a good default.

@d3flex
Copy link
Copy Markdown
Contributor Author

d3flex commented Mar 26, 2026

To me this specific AGENTS.md file looks like a good default.

I am not questioning the context FYI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants