TODO.md

In salim-b/pal: Friendly Convenience/Utility Functions

TODOs

• systematically rely on pkg xfun whenever sensible

• add a standards-conformant changelog for v0.1.0 but use pkg fledge to generate it from Git commits (note the special rules to mark commit msgs for in-/exclusion in the changelog)

  note that according to its README, fledge plays nicely together with the Conventional Commits syntax (which is a lot more universal; e.g. release-please and Release-plz build upon it).

  see also the Rust-written changelog generator git-cliff

• generate a codemeta.json file using pkg codemetar

• release on CRAN:

  1. Thoroughly scan exported fns for possible API improvements (which would be harder to introduce once the pkg is on CRAN) and other outstanding work and implement it.

     • move toml_*() fns to sep pkg (tomlr?)

     • remove deprecated fns: as_flat_list(), fuse_regex(), ...

       (lazier solution might be moving them to pkg salim and adapting downstream accordingly)

  2. Replace pkgsnip::* with constants included in pkg. Make changes in a single commit (only incl. source file Rmd/pal.Rmd), so it can be easily reverted.

  3. Remove Netlify redirect rule / -> /dev.

  4. Release pkg pkgsnip on CRAN.

  5. Revert step 2.

salim-b/pal documentation built on Feb. 28, 2025, 6:51 p.m.