Skip to contents

Version dev

templ.rpkg (development version)

================================================================================ @TEMPL-NOTES-START ================================================================================

Primary reference: https://style.tidyverse.org/news.html#news-release

NEWS.md expectations (Artalytics + tidyverse-aligned)

What belongs in NEWS.md

  • User-facing changes: new features, behavior changes, bug fixes, deprecations.
  • Breaking changes: always called out clearly, with “symptom” + “fix”.
  • Sweeping docs changes: large reorganizations, new vignettes, major onboarding changes.

Do not include purely internal refactors unless they impact users (performance, stability, etc.).

Writing style (bullets)

  • Start bullets with the affected function name (or main concept), as early as possible.
  • Wrap functions, arguments, and filenames in backticks:
    • Use fn() (include parentheses) and arg (no quotes).
  • Use present tense and positive framing (“now does X”).
  • End every bullet with a period.
  • Wrap lines to ~80 chars when possible (especially in release sections).
  • For issues/PRs: use parentheses near the end, typically before the final period:

Structure (headings)

  • Use a level-1 heading (#) for each version:
    • # pkgname (development version)
    • # pkgname 1.2.3
  • During development, keep bullets simple and ungrouped.
  • During release prep, group into sections with level-2 headings (##), commonly:
    • ## Breaking changes
    • ## New features
    • ## Minor improvements and fixes

Within each section, order bullets alphabetically by the first function mentioned.

================================================================================ :TEMPL-NOTES-END ================================================================================

  • Initial template setup (replace this with real entries).