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

Search for implementation of wf features #4

Open
29 of 34 tasks
olivroy opened this issue Jul 4, 2023 · 0 comments
Open
29 of 34 tasks

Search for implementation of wf features #4

olivroy opened this issue Jul 4, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@olivroy
Copy link
Owner

olivroy commented Jul 4, 2023

In rprojroot TODO.md has the following instructions similar to usethis upkeep

Steps for adopting older packages to new development standards

docs branch

  • Create from last released tag
  • Copy .github/workflows/pkgdown.yaml there
  • Fix URL in DESCRIPTION, don't forget trailing slash
  • Tweak _pkgdown.yml
  • Set source of GitHub Pages to branch

Separate pull requests

  • Use GitHub Actions

  • Disable tic

  • Disable Travis CI and AppVeyor

  • usethis::use_coverage()

  • Consider open pull requests

  • Tweak README

    • use downlit::readme_document and load_all() if possible
  • Update roxygen2

  • Use @examplesIf where appropriate

  • styler::style_pkg()

  • Remove Collate:

  • usethis::use_lifecycle_badge()

  • usethis::use_lifecycle()

  • Add pkgdown reference index

  • Adapt tests to testthat 3e

  • Ensure that dependency between source files is cycle-free, as in Caller-callee relationship for .R files in a package yonicd/foreman#2

  • Ensure that source files correspond to test files via devtools::test_coverage_file()

  • Import rlang where appropriate

  • Close open issues

  • Deprecate functions that have moved somewhere else

  • Avoid iris

  • Synchronize with own downstream packages

  • Add type to documentation of function arguments, as in ?here::here

  • Check goodpractice::gp()

  • Switch pkgdown to dev mode "auto"

@olivroy olivroy added the documentation Improvements or additions to documentation label Feb 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant