Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For an example of how release notes should be written for modules see the 'Release Notes' section on the Rest Module Documentation page.

...

The release notes for each version need to include the following:

  • A list of tickets that represent new features in the release
  • List A list of the tickets that represent bug fixes in the release
  • List 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 version