Use a consistent Python test module naming pattern #2039
Labels
🤖 aspect: dx
Concerns developers' experience with the codebase
🧰 goal: internal improvement
Improvement that benefits maintainers, not users
good first issue
New-contributor friendly
help wanted
Open to participation from the community
🟩 priority: low
Low priority and doesn't need to be rushed
🧱 stack: api
Related to the Django API
🧱 stack: catalog
Related to the catalog and Airflow DAGs
Current Situation
Tests in the catalog are named
test_{module}.py
whereas tests in the API are named{module}_test.py
.Suggested Improvement
It'd be nice to have a single, consistent pattern for naming test modules. My vote is to move everything to the catalog pattern as across both test suites we use the pattern
test_{description}
for test functions.Benefit
Using a consistent pattern for test module names across all Python tests would reduce the cognitive load when creating new test modules.
Using the same pattern for test modules and test functions further reduces that cognitive load (only one pattern to remember).
The text was updated successfully, but these errors were encountered: