Creating and Updating Release Notes

Release note files are found in /code/web/release_notes. Files are named for the release in question.  So 24.01.01.MD contains the release notes for the 24.01.01 release.

To make code merges easier while code is being actively developed for a release.  We segment the release notes according to developers. Prefix the section of the release notes with your name prefixed by //. I.e.

//mark

After your name, add the section of the code that you are working on prefixed by ###. I.e.

### Indexing Updates

If you are not sure what section to use, please ask in slack or use Other Updates and the update will be moved to a more appropriate section when all contributions are merged if needed.

Next add a brief description of the change made prefixed by a -. Changes can optionally be followed by a ticket number to assist libraries in checking the release notes for tickets they have submitted.  Finally, end the description of your change with your initials enclosed in quotes and asterisks. I.e.

- Updated button alt text to improve accessibility. (Ticket 1234) (*MDN*)

If a change includes new permissions or settings include the following code after your change.  A blank space should be added between the change description and the code for proper formatting. Settings should describe the full path to the new setting within the admin menu. Permissions should be the name of the permission.

<div markdown="1" class="settings">

#### New Settings
- Primary Configuration > New Setting

#### New Permissions
- Administer Setting

</div>

Finally add your organization and name with initials to the list of contributors for the release.

Merge Process

Prior to the Aspen Gathering all release notes will be merged so that all contributions are listed in order by section.

Change History

  • Created 2024-06-25 MDN - ByWater Solutions