search

SpaceApi / schema

SpaceAPI JSON schema files.
24 stars 14 forks source link

Restructure CHANGELOG, group by top level key #89

Closed dbrgn closed 3 years ago

dbrgn commented 3 years ago

I found the older format quite confusing when trying to systematically implement all changes. The items were not in a logical order, but seemingly random.

Instead, I grouped them by top level key.

gidsi commented 3 years ago

Can we order afterwards by type (added, changed, removed) and then alphabetically?

dbrgn commented 3 years ago

@gidsi I'd prefer not to, because sometimes two entries are related. For example:

- [changed] The `jabber` key was renamed to `xmpp`[#8]
- [added] The `keymasters` array items can also contain a `xmpp` field ([#8])

Those two were previously separate from each other, which confused me a lot when going through the items one by one (because an xmpp field in keymasters is only valid if that's a valid contact entry, but that part of the changelog was listed farther down) :slightly_smiling_face:

I'd optimize for logical grouping.