Re: [Outreachy] Microproject selection
On Thu, Oct 13, 2022 at 2:29 AM NSENGIYUMVA WILBERFORCE <nsengiyumvawilberforce@gmail.com> wrote:
Show 8 quoted lines
> I am reading through https://git.github.io/SoC-2022-Microprojects/ and
> and I found an interesting task I could do which is to "Modernize a
> test script".
>
> When I looked through the code, I found I could clean up t1002 as
> mentioned in https://lore.kernel.org/git/CAPig+cQpUu2UO-+jWn1nTaDykWnxwuEitzVB7PnW2SS_b7V8Hg@mail.gmail.com/
>
> Let me know if I should go ahead
t1002 might indeed be a reasonable microproject since it could use a few of the same cleanups as mentioned in the email you cited. For a microproject, we usually don't want you to take on a large task since the aim of a microproject is for you to experience the patch submission and review process, however, the cleanups t1002 needs are each quite simple, so a multi-patch series would be appropriate. I foresee a series consisting of two to four patches:
(1) reformat tests from:
test_expect_success \
'title' \
'body1
boy2'to the modern form:
test_expect_success 'title' '
body1
body2
'(2) fix indentation to use TABs rather than spaces
(3) optional: move the:
cat >expected <<EOF
-100644 X 0 nitfol
+100644 X 0 nitfol
EOFinto the tests (14 & 15) which need it rather than creating "expected" in the global scope; at the same time, you might change `EOF` to `\EOF`, but be sure to mention that change in the commit message if you do so and explain why `\EOF` is preferred (see the "Recommended style" section of t/README for details)
(4) optional: many tests use the unusual construct:
if read_tree_u_must_succeed -m -u $treeH $treeM; then false; else :; fi
which would be expressed more naturally these days as:
! read_tree_u_must_succeed -m -u $treeH $treeM
In fact, if you want a smaller microproject, the optional item listed last might be a decent microproject on its own without the other changes.