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

use_tidy_upkeep_issue() #1416

Closed
hadley opened this issue Apr 12, 2021 · 9 comments · Fixed by #1514
Closed

use_tidy_upkeep_issue() #1416

hadley opened this issue Apr 12, 2021 · 9 comments · Fixed by #1514
Labels
tidy ✨ tools for the tidyverse team

Comments

@hadley
Copy link
Member

hadley commented Apr 12, 2021

Create an issue to bring your package up to spec with latest changes. Would divide into sections with dates (maybe just years?) so you can choose how far to go back (and some should be re-run regularly).

Initial ideas:

  • use_tidy_description() + devtools::document()
  • use_tidy_github_actions()
  • Remove check environments from cran-comments.md
  • start with devtools::document() for very old. Maybe check that uses md?
  • Update R dependency to match GitHub actions
@jennybc
Copy link
Member

jennybc commented Apr 14, 2021

More ideas:

  • Use testthat 3e -- use_testthat(version = 3)
  • Create a pkgdown site -- use_pkgdown_github_pages()
  • Get your URLs in order (in DESCRIPTION, on GitHub) (depending on initial state, use_github_links() and use_pkgdown_github_pages() take care of this)
  • Consider (re)creating package-level doc to enjoy better usethis management of @importFrom -- use_package_doc()
  • Create README.Rmd if you only have README.md -- use_readme_rmd()
  • Adopt markdown in roxygen -- use_roxygen_md()

@hadley hadley changed the title use_tidy_issue() use_tidy_standards_issue() Apr 14, 2021
@hadley
Copy link
Member Author

hadley commented Apr 16, 2021

What do you think of this presentation? I always lean towards minimal, but maybe it's worth being more verbose?

Pre-history

  • use_readme_rmd()
  • use_roxygen_md()
  • use_pkgdown_github_pages() / use_github_links()
  • use_tidy_labels()
  • urlchecker::url_check()
  • Restyle?

2020

  • use_testthat() and upgrade to 3e
  • use_package_doc()
  • Align naming of R and test files
  • Switch to MIT license

2021

  • Remove check environments from cran-comments.md
  • use_tidy_dependencies()
  • use_tidy_github_actions() and update hand written actions to use setup-r-dependencies
  • Bump required R version in DESCRIPTION to 3.3

Evergreen

  • devtools::document()
  • use_tidy_description()

@jennybc
Copy link
Member

jennybc commented Apr 16, 2021

I like this proposed organisation.

Should we add something about spelling? I confess I'm pretty foggy on what exactly maintaining WORDLIST buys for us and yet I keep doing it in many packages and I don't get bugged about spelling by CRAN 🤷‍♀️

@jennybc
Copy link
Member

jennybc commented Apr 16, 2021

Another change I make when I return to something is renaming .R and test files so that use_r() / use_test() is happy to do my bidding.

@hadley
Copy link
Member Author

hadley commented Apr 16, 2021

I think spelling needs to emerge as more a standard; I've added use_r/use_test() alignment above. We might want to add a little helper to facilitate? (But not sure what it would be called since it could only report, not take action)

@hadley hadley changed the title use_tidy_standards_issue() use_tidy_standards_issue() Apr 18, 2021
@hadley hadley added the tidy ✨ tools for the tidyverse team label Sep 7, 2021
@hadley
Copy link
Member Author

hadley commented Sep 13, 2021

Maybe call this something like use_spring_clean_issue()? I like the idea of getting spring cleaning into the name somehow since that implies an annual cadence (which feels about right to me).

@DavisVaughan
Copy link
Member

use_annual_upkeep_issue() matches our new "upkeep" issue label

@hfrick
Copy link

hfrick commented Sep 21, 2021

another checkbox could be to update artisanal deprecation messages to use lifecycle

@hadley
Copy link
Member Author

hadley commented Oct 11, 2021

I think we should try and get this into this release. I’m happy to take a first pass when I’m back.

@jennybc jennybc added this to the v2.1.0 milestone Oct 12, 2021
hadley added a commit that referenced this issue Oct 12, 2021
For the purposes of discussion. Fixes #1416.
@jennybc jennybc changed the title use_tidy_standards_issue() use_tidy_upkeep_issue() Oct 13, 2021
jennybc pushed a commit that referenced this issue Oct 15, 2021
For the purposes of discussion. Fixes #1416.
jennybc added a commit that referenced this issue Oct 15, 2021
* First stab at use_tidy_upkeep_issue()

For the purposes of discussion. Fixes #1416.

* Update R/tidy-upkeep.R

* Lots of little changes that GitHub's "batch commit" was refusing to let me make via the browser

* Try to determine oldrel-4 dynamically

* Update snapshot

* Rename the issue

* Add NEWS bullet

* Add more hints and links

Co-authored-by: Jennifer (Jenny) Bryan <jenny.f.bryan@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tidy ✨ tools for the tidyverse team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants