Skip to content

Conversation

@de-abreu
Copy link
Collaborator

A proposal to close 133.

ChangeLog.md Outdated
Comment on lines 165 to 175
Added
Changed
Deprecated
Removed
Fixed
Security

MAJOR.MINOR.PATCH
MAJOR version when you make incompatible API changes
MINOR version when you add functionality in a backward compatible manner
PATCH version when you make backward compatible bug fixes
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this some kind of instruction for the changelog? if so, should we move these lines to CONTRIBUTING.md file instead?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That... is a mistake.

@monacofj
Copy link
Contributor

Well, according to our workflow, we haven't yet made any public release.
I was expecting ChangeLog.m to have two entries:

  • 0.1.0 that is the initial state since the project was created
  • `1.0.0' that will be the first release by Dec 17 2024

The intermediate steps are development upgrades and do not consist in releases (there are not tags for them in the repo).

If we are going to stick with conventional changelog, all changes, fixes etc. after the initial code will comprise the v1.0.0 release.

@de-abreu
Copy link
Collaborator Author

I see. That should make it much simpler. I'll commit a new version soon.

@de-abreu de-abreu requested a review from lincolncpp December 12, 2024 20:46
@rodrigo-lex
Copy link
Collaborator

lgtm! However, I would also add to the "Added" section the addition of the orange (#96).

@monacofj
Copy link
Contributor

Good job.
But I was wondering. There were a few bugs in KobraPy and it's ok list their fixes under section Fix.
All other fixes are fixes for new features that did not exist in KobraPy. I believe that listing them as fixes of KobraPy code does not make much sense. Against this background, think v1.0.0 should have only added, removed or changed things...

Removed fixes from problems generated and solved withing the development of a same release. Listed oranges as an addition.
@de-abreu de-abreu merged commit 6732a92 into v1.0.0 Dec 14, 2024
@raultel raultel deleted the doc/133/add-a-changelog branch December 15, 2024 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants