commitizen icon indicating copy to clipboard operation
commitizen copied to clipboard

refactor(BaseFormat): merge ChangelogFormat into BaseFormat

Open bearomorphism opened this issue 3 months ago • 2 comments

Description

BaseFormat already looks like a base class for changelog format, but it has a parent class protocol ChangelogFormat. It is confusing to me.

Additionally, the protocol ChangelogFormat declares implementations of methods. I consider it confusing too.

This change addresses the unnecessary complexity and remove ChangelogFormat completely from the codebase. The alternative now is BaseFormat.

I am not sure if this is a breaking change. Please help to review.

bearomorphism avatar Sep 16 '25 14:09 bearomorphism

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 98.29%. Comparing base (120d514) to head (03abf0d). :warning: Report is 842 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1612      +/-   ##
==========================================
+ Coverage   97.33%   98.29%   +0.95%     
==========================================
  Files          42       58      +16     
  Lines        2104     2695     +591     
==========================================
+ Hits         2048     2649     +601     
+ Misses         56       46      -10     
Flag Coverage Δ
unittests 98.29% <100.00%> (+0.95%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Sep 16 '25 14:09 codecov[bot]

I think @noirbizarre might be a better person to take a look at this one. My guts feeling tells me ChangelogFormat is mostly for typing

Lee-W avatar Nov 08 '25 08:11 Lee-W