...
For an example of how release notes should be written for modules, for an example you can refer to the release notes for the platform release e.g Platform Release Notes 1.10.0. For a module example see the 'Release Notes' section on the Rest Module Documentation page. The , the release notes for each module version need to include the following:
- A list of tickets that represent new features in the release
- A list of the tickets that represent for major bug fixes in the release
- 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 platform or other modules versionplatforms and other module versions
- A list of all tickets included in the release