tidy-deprecate-function
Installation
SKILL.md
Deprecate functions and function arguments
Use this skill when deprecating functions or function parameters in this package.
Overview
This skill guides you through the complete process of deprecating a function or parameter, ensuring all necessary changes are made consistently:
- Add deprecation warning using
lifecycle::deprecate_warn(). - Silence deprecation warnings in existing tests.
- Add lifecycle badge to documentation.
- Add bullet point to NEWS.md.
- Create test for deprecation warning.
Workflow
Step 1: Determine deprecation version
Read the current version from DESCRIPTION and calculate the deprecation version: