Don't include CRAN install instructions to start #1507
Conversation
I've pushed a change that does insert some sort of placeholder in the "no GitHub (yet)" case. What you do think @malcolmbarrett? We could still combine this with a nudge to populate this section via |
| @@ -75,6 +75,7 @@ release_checklist <- function(version, on_cran) { | |||
| "", | |||
|
|
|||
| todo("`usethis::use_cran_comments()`"), | |||
| todo("Update (aspirational) install instructions in README"), | |||
There was a problem hiding this comment.
I think one should revise the README to be (or at least include) install.packages() at the time of CRAN submission, because hopefully that will soon be true and that's what you want baked into the README on CRAN.
|
ruh roh, added it at the same time! I'll revoke mine |
|
Oh wait, that's the checklist item. That makes sense |
|
I brought |
Ideally it would be supported in expect_snapshot_file(), but this workaround serves for now.
This closes #1451 by tweaking the default README instructions. We don't need to add a release bullet point reminding to tweak install instructions because, as it turns out, there's been one for a few years already (😆)
The downside of this simple change is that, if the repo is not on GitHub, nothing gets added to the installation section, and it will be just the header. We could only include the header if already on GH or we could leave it empty as a prompt, perhaps with a poke with
ui_todo()I think there's a lot of people (🤚) who create the README prior to putting on GH, as well.