Versions Compared

Key

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

...

  • Create a CHANGELOG.rst file in your repo, or a “Change Log” section in your README.

  • When changes are made to the repo, describe the change in terms your repo’s audience can understand. Include implications if they are important.

    • Note this means that not every change needs to be in the changelog: internal refactoring, adding tests, updating requirements, and so on are example of things only interesting to the repo developers.

  • Make a new section in the changelog for each release, with the date and the version number.

...