chore: Applying underscores decision #793
Conversation
a-ovchinnikov
requested review from
taylormadore,
eskultety and
brunoapimentel
CONTRIBUTING.md
Outdated
| When naming tests please make sure that prefix `test` is followed by just _one_ underscore | ||
| even when testing methods that start with an underscore (two undrescores are acceptable when | ||
| testing methods whose names start with two underscores). | ||
|
|
There was a problem hiding this comment.
I thought this was supposed to be just an agreement among the core members so as not to point it out again during reviews. I'm not convinced this is something we should have in the guidelines as a strict expectation from external contributors (I'd at least drop the part in the parentheses as that isn't IMO helping to keep things consistent).
Since the second part of this patch is fixing the inconsistency then I'd modify ^this suggestion to a more generic one:
"Please stick to naming which is consistent with our existing function/test names. There's a lot of precedent to follow in our code base. As with anything, despite the best of efforts we acknowledge that there always will be some inconsistencies across the code base which we have missed during reviews. Feel free to fix them along the way if you happen to stumble upon them and help us on improving the status quo."
There was a problem hiding this comment.
I'll just drop it then. Maybe this should be expressed with a flake8 plugin at some point.
a-ovchinnikov
force-pushed
the
underscore_rule_enforce
branch
from
bd1c22d to
7d17d3a
Compare
No test name may contain two underscores between `test` and the first alphanumeric character of a function name. Signed-off-by: Alexey Ovchinnikov <[email protected]>
a-ovchinnikov
force-pushed
the
underscore_rule_enforce
branch
from
7d17d3a to
deeb45c
Compare
| @@ -2455,7 +2455,7 @@ class TestGoWork: | |||
| ], | |||
| ) | |||
| @mock.patch("cachi2.core.package_managers.gomod.run_cmd") | |||
| def test__init__( | |||
| def test_init__( | |||
There was a problem hiding this comment.
test_init__ - I would hope that the trailing underscores would be gone too :), looks weird otherwise.
And recording it in contributor's guidelines.
Maintainers will complete the following section
Note: if the contribution is external (not from an organization member), the CI
pipeline will not run automatically. After verifying that the CI is safe to run:
/ok-to-test(as is the standard for Pipelines as Code)