search

insightsengineering / nestdevs-tasks

0 stars 0 forks source link

Guidelines around `lifecycle::badge` in teal packages #86

Open donyunardi opened 1 week ago

donyunardi commented 1 week ago

Summary

We used lifecycle::badge to indicate the stage of a function (e.g., experimental, stable, deprecated, superseded).

I found a past PR related to this topic:
https://github.com/insightsengineering/teal/pull/456

However, we currently lack guidance on how these badges should transition from one stage to the next (i.e. from experimental to stable) or on when a badge should be removed (i.e. teal::init still has stable badge. Should it be removed?).

Acceptance Criteria:

  1. Discuss and decide on guidelines for transitioning or removing lifecycle::badge in teal packages.
  2. Implement changes based on the decision before the release.
donyunardi commented 1 week ago

Great points from @llrs-roche

Perhaps as part of the insightsengineering/nestdevs-tasks#86 we could decide a policy on the life cycle of functions and arguments? It could incorporate how we search and find internal (looking at internal Roche's code repositories?, asking someone?) and external repositories (searching github?, asking other programmers from other companies?) that could be affected. Similar to how the tidyverse sends PR to affected packages before sending their new version to CRAN.

We'll add this topic to the discussion.