changelog icon indicating copy to clipboard operation
changelog copied to clipboard

Rename internal structs

Open rcmachado opened this issue 7 years ago • 1 comments

Internally, changelog current has the following structs:

  • Changelog: the whole changelog data
  • Version: represents each version
  • ChangeType: Added, Changed, etc.
  • ChangeList: messages for a given "section" (eg. Added).
  • Item: each message

Some of the structs have pretty obvious names (like Version) but others (like ChangeList) could benefit of some more thinking.

rcmachado avatar Jun 23 '18 23:06 rcmachado

Based on terminology adopted at keepachangelog.com website, ChangeType should be called Section.

For consistency, then ChangeList should be renamed to SectionList, SectionContents or similar (TBD).

rcmachado avatar Jan 04 '20 01:01 rcmachado