Best Practices
Release notes are a good way to communicate to users the changes and enhancements in a new version of any piece of software, this page aims to provide module developers with the best practices to adhere to when creating release notes their modules. 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 in the platform release notes will apply to a module modules but it provides a good basis of what you need to include, for or guide to follow. 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:
...
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 way for generating release notes with nearly no effortnotes, it creates separate lists for new features and bug fixes based on the ticket issues types in JIRA.