-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Keep requiring footer? #79
Comments
I think it would be fine to leave it off. A note on this is that between moving to the ropensci repo and the rodocs site, the RO branding can overwhelm people's attempts to associate their package with themselves and their own organization's work. I, for instance, put an EcoHealth footer on READMEs in packages developed through work, and put the authors at the top of the README, and want to keep this after a package goes through peer-review. |
But it's fine to have that footer + the rotemplate style, right? You could also add EcoHealth Alliance as author with a logo, is it fine or would you need more? |
Yes, I think that's fine. If I think of some other option it would be good to have I'll open an issue in rotemplate. |
dont' have a strong feeling on it |
Re-upping this, @jeroen now adds the same footer as for the website for pkgdown websites so the footer is redundant. In READMEs one could argue that there's the peer-review badge at the top. Related (would become useless) ropensci-archive/roweb2#451 |
I think we could drop the banner, and instead ask to add |
btw in GitHub docs I was unable to find docs for that field! The best link I could come up with is https://stackoverflow.com/questions/7757751/how-do-you-change-a-repository-description-on-github |
Agreed, I think we should drop it. |
@maelle in the github api the field is called the repo "homepage": https://developer.github.com/v3/repos/ |
@jeroen I know, but when you edit it it's called website. 😢 And I don't see it e.g. in https://help.github.com/en/github/administering-a-repository |
@karthik fine if we stop requiring the footer? |
Yes I don't really care if it stays or goes. |
cf also ropensci-archive/rodev@a4c5abe |
The footer is useful in GitHub READMEs but it is also redundant in docs website, see e.g. https://docs.ropensci.org/ropenaq/
Once Jeroen's docs project is mature, do we want to keep requiring the README footer? @karthik
The text was updated successfully, but these errors were encountered: