Best Practices
For an example, you can refer to the release notes for the OpenMRS platform releases e.g Platform Release Notes 1.10.0, not everything there might really apply to a module but it provides a good basis of what you need to include, for a module example see the 'Release Notes' section on the Rest Module Documentation page. The release notes for each module version need to include the following:
- A list of tickets that represent new features
- A list of the tickets for major bug fixes
- A list of the data model changes in the release, typically these would be the comments for the respective liquibase changests in the liquibase.xml file assuming they were well written to explain what they are doing.
- Any other things an implementer might need to know if upgrading to a certain version e.g known incompatibilities with certain OpenMRS platforms and other module versions
- A list of all tickets included in the release
If a module's versions are managed properly in JIRA and the fix versions are set well on the closed module tickets in the release, JIRA provides a tool for generating release notes with nearly no effort, it creates separate lists for new features and bug fixes based on the ticket issues types in JIRA.