<!here> based on some feedback from a paper review...
# team-maintainers
j
<!here> based on some feedback from a paper review for #CE9MS66BS I'm looking into clean up the badges 'forest' (as @mashehu called it) What do you think about this before/after: • I've tried to remove stuff I didn't feel was relevant (duplicate unit test, social media), and collapse into relevant categories (note mag has 3 extra non-standard badges on the bottom line after Zenodo) • Iv'e added a badge to access to the documentation • Renamed some (e.g. the AWS megatest outputs, singularity to apptainer etc.) Any thoughts in the thread below pretty please 🙏
Comments go here!
n
I love it!
m
I would group things differently
j
Hit me
For context my current groupoing: • Metadata and resourcfes • Execution info • Citing and other promo
m
For me it should be: L1: Version (NXF, nf-core, Zenodo, citations) L2: Reproducibility (run with, launch with, develop with + CI) L3: Docs (Read doc, see results, slack + other links)
j
What about hte linting/nf-test stuff?
Is that still version?
m
for me it goes with Reproducibility, in CI
so more: • VERSIONS and CITATIONS • EXECUTION and REPRODUCIBILITY • DOCUMENTATION and EXTRAS
j
So like this: (note this is missing a couple as they don't get locally rendered, e.g. Zenodo, conda, slack)
👍 1
l
I would personnaly order them by decreasing length 😅 But this already look quite better !
j
So like in my original version/
(although really this about information presetnation not visuals)
l
Yes, but with the information grouping like Maxime proposed.
j
OK but that is mutually exclusive 😉
m
run nf-test "passing"
and
unit tests "nf-test"
seem to be redundant or could be renamed and combined.
j
I have removed the second one?
m
ah, sorry was confused which one is current.
j
The former I can't rename because it comes from the test itself (it's the github automatic ones)
m
we can (and should) rename the job name
👍 1
j
That can be a separate PR (the badge should update automagically I berlieve)
💯 1
Any other commetns @mashehu? And do you prefer mine or Maxime's?
m
yes, find maxime's a bit clearer, but would do VERSIONS and CITATIONS DOCUMENTATION and LAUNCH + DEVELOP EXECUTION and REPRODUCIBILITY + CI
j
OK, let me finish something and I'll model that, if Matthias' tweaked version of yours is OK @Maxime Garcia?
image.png
✅ 1
Like so?
m
yes! also looks nicely balanced (but i guess that is also a bit due to your extra badges). btw. I thought this all started because you wanted to add links to usage and output docs
j
I could also put output docs, but I think the example results are sort of better for that
👍🏻 1
It was just 'any' link
👍🏻 1
3. It would be useful to have a link to the documentation prominently displayed at the top of the README. It's in the "About" section of the repo, but it would be nice to have amongst all the badges
From the reviewer's comment
@Maxime Garcia @Louis Le Nézet @Nicolas Vannieuwkerke as the others who care, any final thoughts?
Otherwise will update the template
m
Fine with me
In the TEMPLATE I would put each badge on a separate line, it makes it so much easier to udpate
n
Looks good!!
j
@mashehu updated: https://github.com/nf-core/tools/pull/4288 one of the tests fail because I guess the README string for version bump has changed (I added jijer tags around), but I'm not sure how to escaepe those... in the
test_bump_version.py
file...