Skip to content

CHANGELOG.md

Latest commit

 

History

History
47 lines (38 loc) · 1.65 KB

CHANGELOG.md

File metadata and controls

47 lines (38 loc) · 1.65 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Guiding Principles

  • Changelogs are for humans, not machines.
  • There should be an entry for every single version.
  • The same types of changes should be grouped.
  • Versions and sections should be linkable.
  • The latest version comes first.
  • The release date of each version is displayed.
  • Mention whether you follow Semantic Versioning.

Types of changes

  • Added for new features.
  • Changed for changes in existing functionality.
  • Deprecated for soon-to-be removed features.
  • Removed for now removed features.
  • Fixed for any bug fixes.
  • Security in case of vulnerabilities.

[Unreleased / TODO]

  • CNAME file to enable GitHub Pages

[0.0.3] - 2020-10-01

Added

  • docs/ - Add project documentation in Markdown
  • mkdocs.yml - Use MkDocs to generate the project documentation site
  • requirements.txt - Update requirements for MkDocs and mkdocs-material dependencies

Changed

  • AUTHORS.md, LICENSE, setup.py - Updated to add a generic author credentials

[0.0.2] - 2020-10-01

Added

  • .gitignore - for proper versioning of the project
  • LICENCE - Lawyering up
  • README.md - description of project
  • requirements.txt - List project external dependencies
  • setup.py - Make the project distributable

[0.0.1] - 2020-10-01

Added

  • Initialize python project structure with source code