\

My agent.md to improve LLM-assisted code quality

76 points - today at 5:59 PM

Source
  • OptionOfT

    today at 7:52 PM

    A bunch of these should be enforce with linting, that way people who still hand-craft code get the same kind of feedback, e.g. Always use {}, even on a one-line "if" statement. & Keep function names short. Less than 30 characters.

    Then this one really is a pattern that creates a lot of churn:

    - Add a small, to the point, comment to explain what the block does and why. Use examples when possible. Propose ASCII drawings to explain complete systems.

    The what _is_ the code.

      • figmert

        today at 10:12 PM

        Right. I've really struggling to get AI to stop explaining the what. It seems to add it to the commits, PRs, code, wherever it feels like. I've put in multiple places to not write the "what", but the "why", and in multiple ways, but it still does it in one or other place.

        • getnormality

          today at 7:53 PM

          I would never tell an agent to write "what does the code do" comments. Their default comments are already way too fluffy.

            • rustystump

              today at 9:17 PM

              I added to the memory, system prompts, and the prompt itself and every soa model still litters code with the most inane useless crap. I will then get code to review from a coworker using fable/opus. It has more lines of comments then code.

              Maybe I am some god tier code reader (i am not) but i dont think i have ever found a comment in code to be useful in my day job. That isnt true, i once came across

              // submit to the dark lord

              Above the function that sent a payment to PayPal for processing. It made me laugh so I let it be.

              • today at 9:07 PM

            • culi

              today at 10:05 PM

              My biggest pet peeve with agents is when people beg their (non-deterministic) agents to do something that a lint rule could've accomplished

                • irishcoffee

                  today at 10:15 PM

                  Seems like 80% of agent use boils down to: grep | sed -i

                  Which is kind of cool if you’re unaware enough to know to do it yourself.

                  Oh, and find. Agents use find a lot.

          • YuechenLi

            today at 8:29 PM

            Since we are sharing our AGENTS.md, I thought I'd share my own, because most of the time, this is pretty much all you need for LLMs to write good code, everything else can be added per project: ---- *Convergence rule* Every substantial task must end in exactly one of three states:

            A. Success The intended capability works in the real path and the real motivating case materially improves.

            B. Meaningful progression The capability is not complete, but one genuine blocker is removed and the next blocker is isolated with evidence.

            C. Honest stop Further work would require overbroad scope expansion, excessive debt, brittle patching, or tangled logic. Stop and report the reason with concrete evidence.

            Do not continue producing patches once the work stops converging.

            Do not confuse activity with progress. A failed attempt is only acceptable if it leaves behind a narrower problem, stronger evidence, or a justified stop.

            Any partial work must leave the codebase in a cleaner, more legible, and more diagnosable state than before. ----

            A lot of the article's AGENTS.md just feel like telling the LLM agents either something they already know (for example, most of the time they know to use exhaustive switch/match statements instead of "arrow anti-pattern") or seems actively harmful ("keep function names short" seems arbitrary and may cause the LLMs to write weird abbreviations for functions that are harder to read and review.

              • lelanthran

                today at 8:57 PM

                > but one genuine blocker is removed and the next blocker is isolated with evidence.

                What's the difference between a "genuine blocker" and a "blocker"? Why is the next blocker not genuine? Does it become genuine only after isolation?

                  • YuechenLi

                    today at 9:03 PM

                    "Genuine blocker" is mostly there because otherwise LLMs may consider the smallest thing that they couldn't immediately figure out to be blockers and stop without implementing anything. The rule is there to tell the LLM if they can figure out how to resolve the blocker by themselves, they don't have to ask me to help resolve the blocker.

                • maccard

                  today at 9:59 PM

                  How often would you say step C happens and the agent stops when it can’t proceed?

              • newsomix9xl

                today at 9:08 PM

                A great piece.

                I esp liked:

                "- Don't touch blocks of code unrelated to the feature you implement. e.g. Don't add comments to a block of code if you did not create it or modify it. As much as possible try to minimize the number of changed lines when implementing a feature."

                The feature where you ask the LLM to fix one thing and it fixes three things.

                I kept noticing this in diffs.

                • getnormality

                  today at 7:51 PM

                  This is a problem that people mostly have to solve themselves. Like, I've been working with Claude for almost a year now and I have never once seen it write "Arrow Anti-Pattern" code. That, and much of the rest, would be fluff in my projects. Agent instructions are best learned from experience project-by-project.

                  • oumua_don17

                    today at 8:04 PM

                    Just this one line in AGENTS.md has given better results to reduce if not eliminate verbosity and grandeur.

                    **Always use ASD-STE100 Simplified Technical English

                    Disclaimer: I saw this listed in some other HN post that I can' locate right away.

                      • mattjoyce

                        today at 9:24 PM

                        This will produce quite verbose prose. STE100 is good for specs and explanations but it works best with a glossary or terms. will burn tokens.

                        • wpasc

                          today at 8:07 PM

                          idk who came up with it first, but ASD-STE100 has been floating around more since matt pocock put it in one of his skills

                      • Geee

                        today at 8:07 PM

                        I feel like claude.md is like Asimov's laws of robotics. Whatever you write there ends up eventually messing up everything.

                          • jdiff

                            today at 10:07 PM

                            Anything that goes into the context window has that going for it. That's a huge part of why Claude's gone absolutely bonkers with genuine, brutal honesty. The system prompt's absolutely stuffed full of those keywords, so now every single output is tainted with that right from the start.

                        • tomr75

                          today at 9:41 PM

                          I think this is dated. I wonder if the author has tried codex/other harnesses

                          • eschaton

                            today at 9:42 PM

                            I didn’t see anything in there instructing the LLM not to generate text about goblins.

                            • Luker88

                              today at 8:35 PM

                              I had good results with making it add a few lines with a summary of RFC 2119/8147 keywords (SHALL/MUST...), and then using those, uppercase.

                              local llm remain more in line like that.

                              • latchkey

                                today at 10:00 PM

                                this was what i was doing 3-4 months ago. i just have AI write/update my agents.md file now as i find problems. i also have ai keep a set of design documentation that it can update as it goes too. oh and he should try omp+codex/xhigh, he will probably be less annoyed.

                                • FooBarWidget

                                  today at 8:13 PM

                                  One tactic I’ve found helpful is multi pass quality improvement. First make it work. Then review for guidelines adherence. Loop until satisfied.

                                  • bellowsgulch

                                    today at 8:09 PM

                                    I've read a few of these over the years, and none of them seem to be useful. I have three sentences in my custom instructions, and those are basically all useless, too.

                                    Even my second one, "Avoid decorative or section-header comments. Never use `----` or `====` as comment separators. Comments should explain only non-obvious behavior, rationale, constraints, or implementation details." seems to be ignored by models regularly, so I don't see the point.

                                    But this is in my private harness. Perhaps other harnesses have better instruction following. My custom instructions are prepended to my first user message, not set as a system message.

                                      • dan_ggggg

                                        today at 9:14 PM

                                        > I've read a few of these over the years, and none of them seem to be useful.

                                        AI users are overwhelmingly addicts who are lying to themselves and the people around them. I've lost patience for their kind.

                                    • dude250711

                                      today at 8:45 PM

                                      It seems like everyone goes through a detailed AGENTS.md phase.

                                      • sohaibqasem

                                        today at 10:03 PM

                                        [dead]

                                        • acedTrex

                                          today at 7:55 PM

                                          Agents.md is such a ridiculous concept, just write good contributing docs and then optionally @ the file in whatever agetn file you use.

                                          That way everyone benefits.

                                            • FooBarWidget

                                              today at 8:16 PM

                                              No, why should I have to remember to @ in every prompt? Or ask contributors to remember. It just makes it easier to make human mistakes. I have better things to do than micromanagement. There is huge value in auto-included context.

                                                • anygivnthursday

                                                  today at 8:34 PM

                                                  The GP wrote @ it from the agents.md file, not from the prompt. Their point was that instead of writing "how to contribute" instructions for agents, you could explain that in the CONTRIBUTING.md and link it from your agents file, so both humans and agents read it from one place.

                                                    • formerly_proven

                                                      today at 9:09 PM

                                                      Symlinks exist, but it's kind of ridiculous all harnesses just ignore CONTRIBUTING, HACKING and friends.

                                                  • acedTrex

                                                    today at 8:39 PM

                                                    You put the @ in the context file the LLMs all use, claudemd agentsmd whatever the thing that most harnesses force load.

                                                    Then the model will go discover what it needs to.