Closed llrs closed 2 years ago
Thanks for the reminder. I haven't forgotten about these, and we literally just had a chat about the issues open on the pkgrevdocs
repo.
I'll answer your last question first. Yes, the two books are meant to host different contents. However, both books are still very much work in progress. How much they complement each other, and how much they may overlap is still open for discussion, and undoubtedly something that will settle over time, as we identify specific points and decide where they should go.
The bioc_mentorship_docs
repo is meant to contain materials generated to support the mentorship program.
The pkgrevdocs
repo is meant to contain the official guidelines for developing, reviewing, and maintaining Bioconductor packages.
Not exactly the same thing then. I expect bioc_mentorship_docs
to point a lot of pages in the pkgrevdocs
book, but I also expect the mentorship materials to provide a bit more of a narrative around the guidelines and how they are applied in practice.
The mentorship program is barely starting, so we will have a much more fruitful discussion after the first round of mentoring ends, with respect to what the mentorship materials will contain in the future.
Finally, coming back to your first question. I would suggest to leave your open issues here, to avoid unnecessary noise (imagine if we decide to bring them back here, and so on).
I would only move any of them to the pkgrevdocs
(or close them altogether) if someone actually decides to send a pull request to pkgrevdocs
that resolves any of them.
I know that the current setup may not look ideal - two repositories of inter-related contents - but we are simply at a point in time where contents and boundaries are being defined, so it's natural to have a bit of confusion until the dust settles.
Thanks again for being careful as ever, it's always good to have those discussions to clarify things (as best as we can anyway!).
Best Kevin
Many thanks for the fast reply Kevin.
I was just reminded by your issue https://github.com/Bioconductor/pkgrevdocs/issues/43 which I though that it was already addressed then I realized this was on this repository, and wondered about the plans for this repository.
Looking forward to success of the mentorship program and the future materials that will be here.
Ah! Thank you. I knew I had fixed that somewhere. I was surprised to see it 'again'.
There are many open issues on this repository:
1
2
3
4
5
6
7
8
I wrote issues 2-7 from a question on the slack and a suggestion from Kevin, but probably they might be of interest for the official Contribution guide or FAQ site. Should all the issues here be moved to the other repo (https://github.com/Bioconductor/pkgrevdocs) with the content officially served on the website or is this intended to hold a different book with different content?