Tracking Changes¶
Feature-level changes to code are tracked inside CHANGES.rst
.
The title of the CHANGES.rst
file should be Changelog
.
Example:
Changelog
=========
1.0.0-dev (Unreleased)
----------------------
- Added feature Z.
[github_userid1]
- Removed Y.
[github_userid2]
1.0.0-alpha.1 (yyyy-mm-dd)
--------------------------
- Fixed Bug X.
[github_userid1]
Add an entry every time you add/remove a feature, fix a bug, etc. on top of the current development changes block.