Skip to content

Holodeck Release Notes Template

Jayden Milne edited this page Jun 3, 2019 · 1 revision
Holodeck %VERSION%
--------------
%RELEASE DATE MM/DD/YYYY%

Short, two sentence summary (ie most important new features, bug fixes)

Highlights
~~~~~~~~~~
- List features and bug fixes you're most proud of here. Should be fairly short, and assume this is all
  users are going to read
- Breaking changes

New Features
~~~~~~~~~~~~
- Exhaustive list of all new features and changes here
- %SHORT DESCRIPTION%
  (`#%GITHUB_ISSUE_NUMBER% <https://github.com/BYU-PCCL/holodeck/issues/%GITHUB_ISSUE_NUMBER%>`_)

Bug Fixes
~~~~~~~~~
- Exhaustive list of all the bugs present in the previous version that have been fixed
  (ie don't include bugs that were introduced & fixed during development)
- %SHORT DESCRIPTION%
  (`#%GITHUB_ISSUE_NUMBER% <https://github.com/BYU-PCCL/holodeck/issues/%GITHUB_ISSUE_NUMBER%>`_)
- You can link to methods if you want: :meth:`~holodeck.environments.HolodeckEnvironment.reset`.