https://nf-co.re logo
Join Slack
Powered by
Looking for reviews for <#C062H82UCRG|> v2.0.0 Cha...
# release-review-trading
j
Looking for reviews for #C062H82UCRG v2.0.0 Charming Chaac! https://github.com/nf-core/createtaxdb/pull/133 Mostly template merge and module updates, otherwise 2 new modules and a deprecation of a functionality. Happy to trade!
👀 1
✅ 1
m
Count me in
❤️ 1
I like that file: docs/usage/dev.md
j
Yeah, I used to have it on hackmd but realised that is silly and hidden
m
how about we put this on the website for all nf-core pipeline devs
j
In the template you mean?
I think it would be a good ieea
m
No, I meant just on the website, I think this could be general
j
Ah so by default having a 
dev.md
skeleton where devs add their checklists?
m
yeah
like a global guideline
something for #C09H9L3R614
j
I don't think we can have a common one there
For me I was describing a very creaetaxdb specific preocedure
But as a general rule/checklist
I guess we have that technically with the 
contributing.md
but do we do anything with that?
m
It's just I think we have a lot of boilerplate code and docs in the TEMPLATE, that end up in the pipeline that I think can be centralized
👍 1
j
@mashehu it looks like you most recently touched 
contributing.md
I just remembered that this is required as a part of GitHub health. How easy would it be easy to render this file on the website (and thus I can drop my standadlone 
dev.md
page...)
m
semi-easy
j
I shall make an issue 😬
m
I feel actually github is a better place for contributing docs, but maybe I am too old-school there. any opinion, @Phil Ewels ?
j
The other reason why I thought having contributing docs on each pipeline page is that it would maybe also make it 'visible' that we are open to contributions
m
I see your point
I just don't like duplicating docs
j
Also 
cONTRIBUTING.md
is hdden away in 
.github/
Which is not where I would go for docs...
And if I go to the markdown file: https://github.com/nf-core/createtaxdb/blob/main/docs/usage/dev.md I still can't use the checklist interactive functionality - if you see what I mean/
p
Also 
cONTRIBUTING.md
is hdden away in 
.github/
It doesn't have to be, it can also be root-level. I just generally try to keep the root of the repo clean where possible, so if there's an option to put stuff in subdirectories then I usually do.
The advantage of having them in the repo is that when folks create a new PR for the first time, GitHub shows a little notification linking to the contribution docs
We could have best of both worlds by keeping that file very short, and linking out to the website for it for longer form stuff.
Checklists: you just need to read the nf-core markdown docs @James Fellows Yates 😉
😆 1
😬 1
j
1. Good to know they can be anywhere! maybe we can move them into 
docs/
as I think it would be a better place to find them 2. I don't mind having my dev instructions in CONTRIBUTING.md, it's more I want the fun interactivity stuff displayed on the website 😬 3. Yes, I realised that after but then I wasn't sure how backwards compatible with GitHub 🤔 (but it seems like their checklists things don't work in just plan markdown files). So I think it would be nice to have it also rendered on the website? So to recap: Is there any objection of having the website rendering the 
CONTRIBUTING.md
file by default?
p
Was about to tell you that it won't work in 
docs
but you're right! Cool, I wonder if that's new..? root, 
.github/
or 
docs/
m
I'd rather have it in .github I think I remember that's what they advise
p
They advise any of the above 3
👍 1
I don't think it makes any difference which it's in, the github functionality works the same across them
Open in Slack
PreviousNext
Powered by