Skip to main content

HACKS.md

The most valuable comments I find in any given codebase look like this:

Hack! This thing is weird because of this and that reason. I tried to implement a more elegant solution, but due to X and Y constraints, I failed.
Hack! This is weird because there is a bug in library X that we depend on. See https://github.com/library/issues/420
Note! I tried options A, B, and C and decided to do this weird thing because, while it looks wrong, it turned out to be the best solution at the time of writing.

These comments do not explain what the code does. They explain why the code looks the way it does. They bring into light historical context, failed attempts, and external constraints that are otherwise invisible.

We all occasionally fail to communicate our intent to the next developer. That is normal and unavoidable. What matters is leaving a clear mark when something non-obvious or hacky is done on purpose.

Increasingly, the “next developer” is a metal-headed clanker: an LLM. LLMs are actually quite good at reading and understanding these comments. The problem is not comprehension. The problem is behavior. They tend to remove these comments, or when they introduce new hacks—either because they were instructed to or because they did so autonomously—they fail to leave the valuable "hack warning" comment traces.

Anyone who works with LLM-generated code has seen the opposite failure mode as well.

By default, LLMs are extremely verbose with comments. They happily pollute a codebase with low-value noise: restating what the code already says, line by line. Writing comments appears to be a behavior that is surprisingly hard to disable.

To add insult to injury, they often overwrite or delete the few comments that actually matter, the why comments, while adding commentary explaining trivial stuff that is self-evident from the code itself. The result is strictly worse than either a well-commented or an uncommented codebase: the signal is gone, the noise remains.

This led me to wonder whether hack documentation should live somewhere else entirely. Should there be a HACKS.md? Or would it be enough to give the agent explicit instructions about how to treat this class of comments?

Since there is no HACKS.md, I added a short, explicit rule to AGENTS.md:

If a hack or workaround is required, leave a comment explaining why it was done. Do not remove these comments unless you have confirmed they are no longer valid. Prefix such comments with NB; (nota bene).
Labels:

Comments

Post a Comment

Popular posts from this blog

I'm not a passionate developer

A family friend of mine is an airlane pilot. A dream job for most, right? As a child, I certainly thought so. Now that I can have grown-up talks with him, I have discovered a more accurate description of his profession. He says that the truth about the job is that it is boring. To me, that is not that surprising. Airplanes are cool and all, but when you are in the middle of the Atlantic sitting next to the colleague you have been talking to past five years, how stimulating can that be? When he says the job is boring, it is not a bad kind of boring. It is a very specific boring. The "boring" you would want as a passenger. Uneventful.  Yet, he loves his job. According to him, an experienced pilot is most pleased when each and every tiny thing in the flight plan - goes according to plan. Passengers in the cabin of an expert pilot sit in the comfort of not even noticing who is flying. As someone employed in a field where being boring is not exactly in high demand, this sounds pro...
Post a Comment
Read more

RocksDB data recovery

I recently needed to do some maintenance on a RocksDB key-value store. The task was simple enough, just delete some keys as the db served as a cache and did not contain any permanent data. I used the RocksDB cli administration tool ldb to erase the keys. After running a key scan with it, I got this error Failed: Corruption: Snappy not supported or corrupted Snappy compressed block contents So a damaged database. Fortunately, there's a tool to fix it, and after running it, I had access to the db via the admin tool. All the data was lost though. Adding and removing keys worked fine but all the old keys were gone. It turned out that the corrupted data was all the data there was. The recovery tool made a backup folder, and I recovered the data by taking the files from the backup folder and manually changing the CURRENT file to point to the old MANIFEST file which is apparently how RocksDB knows which sst (table) files to use. I could not access the data with the admin tool, ...
Post a Comment
Read more

"You are a friendly breadwinner"

A recent blog post by Pete Koomen about how we still lack truly "AI-native" software got me thinking about the kinds of applications I’d like to see. As the blog post says, AI should handle the boring stuff and leave the interesting parts for me. I listed down a few tasks I've dealt with recently and wrote some system prompts for potential agentic AIs: Check that the GDPR subprocessor list is up to date. Also, ensure we have a signed data processing agreement in place with the necessary vendors. Write a summary of what you did and highlight any oddities or potentially outdated vendors. Review our product’s public-facing API. Ensure the domain objects are named consistently. Here's a link to our documentation describing the domain. Conduct a SOC 2 audit of our system and write a report with your findings. Send the report to Slack. Once you get approval, start implementing the necessary changes. These could include HR-related updates, changes to cloud infras...
Post a Comment
Read more