OpenEnergyPlatform / oemetadata

Repository for the Open Energy Family metadata. Contains metadata templates, examples and schemas. For metadata conversion see https://github.com/OpenEnergyPlatform/omi
https://openenergyplatform.github.io/oemetadata/
MIT License
21 stars 3 forks source link

Patch version v1.5.3? or go directly to v2.0.0 #126

Closed jh-RLI closed 1 year ago

jh-RLI commented 1 year ago

I would suggest releasing a patch that includes the current changes.

This would help us make version 1.5 complete. The current changes fix the url in the context field, improve the schema and add more general things like the citation.cff and more.

The only real changes to the spec are the new fields for badges and examples in schema.json. These are not groundbreaking changes.

I could do a quick release now.

Then we can move on to the other changes.

What do you think @christian-rli @wingechr @Ludee @chrwm

chrwm commented 1 year ago

If you don't consider "new fields for badges and examples in schema.json" a feature that is fine for me.

Otherwise we could also release a 1.5.X with

And include the badges and examples in schema.json as feature in 2.0.0 instead of an 1.6.0

christian-rli commented 1 year ago

It seems a bit messy to me to include the badges in a version 1.5.X. It was my understanding that it is a new feature to be introduced in 2.0. I do see the appeal of a smaller update with the features you described @chrwm . Over all, I would vote in favor of a small release.

jh-RLI commented 1 year ago

I would use the 2.0.0 for major changes like 100% compatibility with frictionlessData. I would like to release the badges soon and not use a major version but rather a minor version 1.6.0, otherwise this would seem like a very big update. We are adding a new feature but not changing the structure of the Oemetadata specification, so there are no breaking changes.

This also aims at our release early release often "policy".

christian-rli commented 1 year ago

So without any objections it seems like there is a consensus in favor of a small release. Proposed procedure: