t/run/todo.t Add list of tickets we don't need tests for #23518
Conversation
This file is designed for potential newcomers to work in. The comments should be first, for their benefit.
Add a list of issues that we don't need TODO tests for, so that someone doesn't waste their efforts.
khwilliamson
changed the title
| # Before you add a test here, check that the ticket isn't one of these, | ||
| # because we already have todo tests for them (in some other file). | ||
| # | ||
| # Git Hub issue numbers |
There was a problem hiding this comment.
I'm not sure if this really is the best approach..
My expectation is that the list of issue numbers will become out-of-sync and won't be updated when new todo tests are added in other files..
A possible alternative: update the TODO-tests that uses RT/perl numbers and replace (or add) the GitHub numbers and change this to include something like:
Before adding a test check that a TODO test does not yet exist by running:
git grep "GH ..." t
(A starting point for the old RT numbers: git grep -E 'TODO.*(perl|RT)[[:space:]]*#' t/ dist/ ext/)
There was a problem hiding this comment.
I still think it is the best approach at this time. I will be watching for this getting outdated and take steps to make sure it doesn't. And that won't require very much work as it is quite rare for a TODO test to get added that isn't quickly removed. One set was added by @iabyn a year ago as a result of his reworking the XS parsing. The previous instance was a year before that via 981e5d6
I'm now reluctant to use GH as a prefix to ticket numbers, as it seems to break their automatic closing by the system when a p.r. gets merged that refers to a ticket with that prefix.
The list was created by me by going through the code, looking for every extant use of todo. It should be complete as of now, and no one is going to add anything new for things that use non-GH numbering.
There was a problem hiding this comment.
And I'm trying to make this as simple as possible so people thinking of contributing have as little extra steps to take as possible
This file is designed for potential newcomers to work in. Make it easy for them to find tickets not needing tests.