Tracking the under the hood stuff is not useful for Users, but can be helpful for developers...especially now that we have longer release cycles.
Currently the PR Template points to only user-facing stuff should be documented. This should be amended to allow developers to note bigger changes to the code base
For example,
The removal of renv from our development process is a big change and warrants mention
The refactor of the date/time functions warrants a mention
Turning off lintr indentation does NOT warrant a mention
Removing the Render Readme CI action does NOT warrant a mention
Definition of Done
[ ] PR Template section on the news update should be made more developer friendly
[ ] Developer Notes should be created in the news.md file
[ ] Move all developer content to this section
[ ] Possible to make this collapsible so interested folks can take a look, but doesn't take up too much real estate!
[ ] Find a home in admiraldev that discusses best practices for writing News entries (not sure if there is one)
Background Information
Tracking the under the hood stuff is not useful for Users, but can be helpful for developers...especially now that we have longer release cycles.
Currently the PR Template points to only user-facing stuff should be documented. This should be amended to allow developers to note bigger changes to the code base
For example,
renvfrom our development process is a big change and warrants mentionDefinition of Done