Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unified comments in unit tests #335

Open
sonniki opened this issue Mar 3, 2025 · 1 comment
Open

Unified comments in unit tests #335

sonniki opened this issue Mar 3, 2025 · 1 comment
Labels
good first issue Good for newcomers

Comments

@sonniki
Copy link
Contributor

sonniki commented Mar 3, 2025

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 sonniki added the good first issue Good for newcomers label Mar 3, 2025
@sonniki sonniki self-assigned this Mar 3, 2025
@gpsaggese
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants