Versions Compared

Key

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

...

  • The name of the changelog may be specified in any case, but at least the letter "C" must be capitalized. We are using markdown, so the extension must always be ".md".
  • Within the changelog:
    • The date stamp must always be specified as either YYYY-MM-DD or YYYY/MM/DD.
    • The JIRA ticket associated with the changes that went into a version should be noted.
    • It is not necessary to have both the JIRA ticket number AND a link to the JIRA ticket.
    • There should be an entry for every single version.
    • The latest version must always be first, in reverse time order.
    • An [Unreleased] section is optional. (JIRA tickets should be used in lieu of an [Unreleased] section.)

...