helpers icon indicating copy to clipboard operation
helpers copied to clipboard

Unified comments in unit tests

Open sonniki opened this issue 9 months ago • 1 comments

Our doc about writing unit tests should mention that we strongly encourage the use of consistent concise comments in unit tests that establish a unified unit test structure:

# Prepare inputs.
...
# Run.
...
# Check.
...

FYI @gpsaggese

sonniki avatar Mar 03 '25 14:03 sonniki

Yes indeed. Let's add it to the conventions.

This is another task that (maybe?) an LLM can perform automatically with humans to review it. My take is to have automatic ways for some of the code maintainers to patch the code already existing and for LLMs to do the first line of defense on a PR (saying what we say all the times!) Humans should follow the conventions for new code.

gpsaggese avatar Mar 05 '25 23:03 gpsaggese

Done, closing

sonniki avatar Mar 31 '25 18:03 sonniki