Skip to content
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

Code of Conduct link in README needs to be full URL #772

Closed
jennybc opened this issue May 27, 2019 · 3 comments · Fixed by #917
Closed

Code of Conduct link in README needs to be full URL #772

jennybc opened this issue May 27, 2019 · 3 comments · Fixed by #917
Labels
bug an unexpected problem or unintended behavior git git, GitHub, and CI in general wip work in progress

Comments

@jennybc
Copy link
Member

jennybc commented May 27, 2019

There's a new CRAN check that gets triggered by README links to files below .github/, such as the code of conduct.

Make sure usethis's tools replace this internal link with a full URL. Probably to the file on GitHub? The one I just did "by hand" links to the file in the pkgdown site, which is probably a nice solution, but that can't really be the default strategy.

@hadley
Copy link
Member

hadley commented Jun 21, 2019

Note that problem still applies even if the file is in the root directory because we .Rbuildignore them to solve a different R CMD check problem.

@jennybc
Copy link
Member Author

jennybc commented Jul 2, 2019

I'm tagging this for Tidyverse-dev-day. Even if someone opts NOT to fix the logic / template in usethis, making PRs to fix READMEs in existing repos would still be great. Here's the sort of commit that's needed to fix this post hoc in the case of a package that has a pkgdown site:

77d49e4

@jennybc jennybc added bug an unexpected problem or unintended behavior git git, GitHub, and CI in general tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day labels Jul 2, 2019
@krlmlr
Copy link
Member

krlmlr commented Jul 9, 2019

If pkgdown exposed its configuration settings, usethis could query and adapt.

hadley added a commit that referenced this issue Oct 17, 2019
@hadley hadley added wip work in progress and removed tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day labels Oct 17, 2019
hadley added a commit that referenced this issue Oct 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug an unexpected problem or unintended behavior git git, GitHub, and CI in general wip work in progress
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants