...
Release notes are critical and should be added as soon as possible so that libraries and hosting providers have as much time as possible to review notes and prepare. Starting with Poppy, release notes deadlines have been added to release timeline. Poppy final release notes deadline is October 13 2023.
Current release notes layout
Section 1: Notes on functionality > PO release presentations
...
- This section outlines all changes that require special consideration for customers in production. Configuration changes may be needed to prevent operational interruptions. See checklist for guidelines on how to fill this out.
- PO and/or Dev lead must complete this section and should include any critical changes and or required migration/upgrade actions for hosting providers.
...
- Update release notes once a feature and/or issue is set to PO Review.
- Include any previous release notes that still relate to the release
- Ask SM to coordinate time for devs to add release notes throughout the release
- If no SM, PO should remind devs to add release notes throughout the release
- Add a label to track known issues for a release
- Add a label for features/issues that require a release note
- Beware of any updates/migrations that may result in significant service disruption or results in significant changes to data (i.e. MARC - FOLIO mapping rules changes)
- Please remember to update release notes if required for a Critical service patch (CSP)
...