Skip to content

Latest commit

 

History

History
101 lines (71 loc) · 4.9 KB

CHANGELOG.md

File metadata and controls

101 lines (71 loc) · 4.9 KB
Raw

Changelog

All notable changes to this project will be documented in this file.
For each version, important additions, changes and removals are listed here.

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

[Unreleased]

Added

  • Add a favicon for the documentation (54#)
  • Add a warning for older versions that links to latest (#54)
  • Add pre-commit and setup pre-commit-hooks (#56)
  • Add a community chat on Element (#59)
  • Add documentation on the regular community meetings (#60)
  • Add CI-based automated testing and linting on commit and pull requests (#55)
  • Add license files to folder LICENSES (#64)
  • Add dep5 file for copyright notices (#64)
  • Add pre-commit hook for REUSE (#64)
  • Add copyright notice to all files (#64)
  • Add first version of pyproject.toml (#64)
  • Add documentation for code style (#63)

Changed

  • Update CSS to improve toc (#54)
  • Update documentation for mike (#54)
  • Update GitHub Action for develop branch (#58)
  • Update the sections and merge subpages of the documentation (#62)

Removed

  • Disable GitHub Action for MkDocs Workflow (#54)
  • Remove merged documentation files (#62)
  • Remove the LICENSE.txt file (#64)

[0.2.0] Minor Release - Oh Hi Mike - 2023-08-11

Added

  • Add documentation version control with mike (#47)

Changed

  • Update issue templates and release procedure (#47)

[0.1.1] Patch Release - Emmy Hennings Day Patch - 2023-08-10

Added

  • Add issue template for release issue_template_release.md (#43)

Changed

  • Update the release procedure (#43)

[0.1.0] Minor Release - Emmy Hennings Day - 2023-08-10

Added

  • LICENSE.txt
  • CITATION.cff (#2)
  • CONTRIBUTING.md (#2)
  • USERS.cff (#2)
  • CODE_OF_CONDUCT.md (#3)
  • CHANGELOG.md (#6)
  • README.rst (#10)
  • Add a logo to the README (#18)
  • Add mkdocstrings (#20)
  • Add example code with google docstrings (#20)
  • Add requirements.txt for python environment dependencies (#20)
  • Add templates for issues and PR (#15)
  • Add a GitHub workflow to deploy documentation (#25)
  • Add permanent links for documentation sections (#28)
  • Add documentation on documentation files [(#35)](#35
  • Add RELEASE_PROCEDURE.md (#37)

Changed

  • Update the .gitignore (#19)
  • Update the documentation file structure (#28)

Removed

  • Remove the src folder (#26)

[0.0.0] Initial Release - Hello Super-Repo - 2022-03-03

Added

  • GitHub repository
  • .gitignore
  • LICENSE (MIT License)
  • GitHub Projects for software versioning