search

kvas-it / pytest-console-scripts

Pytest plugin for testing console scripts
MIT License
78 stars 14 forks source link

Reformat changelog and add unreleased changes. #79

Closed HexDecimal closed 1 year ago

HexDecimal commented 1 year ago

A changelog has to show only what's relevant to the users of the library.
See https://keepachangelog.com/en/1.0.0/

Also added minor updates to the readme: Suggest pip install -e . for dev installs. Point the unreleased commits badge to the changelog.

codecov[bot] commented 1 year ago

Codecov Report

Merging #79 (2e28ce7) into master (24ca589) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #79   +/-   ##
=======================================
  Coverage   99.53%   99.53%           
=======================================
  Files           1        1           
  Lines         217      217           
=======================================
  Hits          216      216           
  Misses          1        1
HexDecimal commented 1 year ago

Yes, new PR's with user-facing changes will be added manually to the changelog. Which also means the [Unreleased] section needs to be preserved during a new release.