Skip to content

chore: add instructions for coding ai in agents.md #987

Merged
mburri merged 3 commits intomasterfrom
chore/add-windsurf-rules
Apr 1, 2026
Merged

chore: add instructions for coding ai in agents.md #987
mburri merged 3 commits intomasterfrom
chore/add-windsurf-rules

Conversation

@mburri
Copy link
Copy Markdown
Member

@mburri mburri commented Mar 31, 2026

We are using Windsurf - I started to create some guidelines to improve the generated code for new stuff.

what do you think?
Should we share the rules?

@mburri mburri requested review from StephGit and yvespp March 31, 2026 08:35
@yvespp
Copy link
Copy Markdown
Member

yvespp commented Mar 31, 2026

IMHO if we have one, we should have a very small one that only has the most important stuff. A paper by ETH showed that it can make AI responses worse, probably because of the larger context:

@mburri
Copy link
Copy Markdown
Member Author

mburri commented Apr 1, 2026

@yvespp this is a good input - in many ways. I learned about the agents.md file - this probably works for various coding ai tools - at least it works with our windsurf ide and intellij plugin. I did not try with claude or copilot. Meanwhile, the .windsurf folder seems to be specific to windsurf ide and plugins.

The agents.md files can be placed in the root and in subdirectories. If the file is in the root, it is always on, while files in subdirectories only apply for "work" in the subdirectories. This would be nice for us to split and focus instructions for each module (angular, amw_rest, e2e...)

A coworker also suggested to look up the following project: https://github.com/drona23/claude-token-efficient
The idea is to tell the agent to be concise and short in order to save tokens.

I'd propose to add a agents.md file with some general info about the product and the instructions in https://raw.githubusercontent.com/drona23/claude-token-efficient/refs/heads/main/CLAUDE.md

And then go on from there, gradually update and improve the files as needed.

@mburri mburri changed the title chore: add windsurf rules as guidelines chore: add instructions for coding ai in agents.md Apr 1, 2026
@yvespp yvespp added this to the Release v1.18.11 milestone Apr 1, 2026
@mburri mburri merged commit ee12c4a into master Apr 1, 2026
1 check passed
@mburri mburri deleted the chore/add-windsurf-rules branch April 1, 2026 11:32
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.

2 participants