Open Bisaloo opened 5 years ago
thanks @Bisaloo ! didn't know about this. I think this will take some discussion as this would put these files in each community contr. repo - and maybe we need to communicate to the comm. contribs before that happens, etc.
thoughts on this @cboettig @maelle @stefaniebutland ?
oooh cool, nice find @Bisaloo . I wonder whether it might be a bit too much for some developers? I.e. would some want to opt out and in that case would they need to create different/empty community health files?
I also wonder whether it means pkgdown would find them and render them (probably not because they would not be in each repo per se).
the docs says that each repo can override the organization wide files with their own - so that's pretty straight-forward.
i don't know about the pkgdown stuff
My guess is that people would appreciate having default files for Code of Conduct and Contributing, especially in the case where they are dealing with their first package that requires these (i.e. a relief not to think through yet another thing). Also key that they can be replaced by pkg owner
if we go with that and pkgdown doesn't find the code of conduct @jeroen could we copy the default code of conduct to the package folder before building when there's no code of conduct in the folder? :thinking:
I'd rather not. We have a link to the general rOpenSci code of conduct in the website footer now. I don't think it's needed to put a yet another copy in each package documentation, unless the package author really wants this.
Updating this thread to note that since @jeroen added rOpenSci website footer to pkgdown websites, the COC is linked from all pkgdown websites. :ok_hand:
I'm not sure if that's a new feature but it looks like GitHub allows the use of community-wide defaults for the Code of Conduct and the Contributing Guide. From what I understand, renaming this repo would allow rOpensci default CoC and Contributing Guide to appear in repo where maintainers have not set them up.
https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization