Back to all reviewers

document test configurations

jj-vcs/jj
Based on 2 comments
Toml

When modifying test configurations or tooling settings, provide clear explanations of what the changes actually do and why specific options were chosen. Test configuration changes can be confusing without proper context.

Testing Toml

Reviewer Prompt

When modifying test configurations or tooling settings, provide clear explanations of what the changes actually do and why specific options were chosen. Test configuration changes can be confusing without proper context.

For commit messages, explain the current behavior and what’s being changed:

# Good
nextest: mark tests that last >10s as "SLOW"

Nextest currently marks tests as SLOW if they take more than 5 seconds.
This increases the threshold to 10 seconds to reduce noise.

# Avoid
nextest: mark tests that last >10s as "SLOW"

For configuration files, consider adding comments explaining non-obvious settings:

[tasks."check:test"]
tools."cargo:cargo-nextest" = ""
# Show slow and retried tests to balance informativeness with readability
env.NEXTEST_STATUS_LEVEL="slow"

This prevents confusion about what configuration changes actually accomplish and helps future maintainers understand the reasoning behind specific test tool settings.

2
Comments Analyzed
Toml
Primary Language
Testing
Category

Source Discussions