Skip to content

Rename internal structs #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
rcmachado opened this issue Jun 23, 2018 · 1 comment
Open

Rename internal structs #18

rcmachado opened this issue Jun 23, 2018 · 1 comment
Labels
help wanted Extra attention is needed question Further information is requested

Comments

@rcmachado
Copy link
Owner

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 rcmachado added help wanted Extra attention is needed question Further information is requested labels Jul 7, 2018
@rcmachado
Copy link
Owner Author

rcmachado commented Jan 4, 2020 •
edited
Loading

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed question Further information is requested
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rcmachado