SignalK / specification

Signal K is a JSON-based format for storing and sharing marine data from different sources (e.g. nmea 0183, 2000, seatalk, etc)
Other
91 stars 68 forks source link

Zones-meta and Notification updates #664

Open godind opened 2 months ago

godind commented 2 months ago

Update to change ffrom alarm to notification. Adjusted zones and operationnal concept.

sbender9 commented 2 months ago

Can you write a larger summary of the changes? Really hard to parse and make sense of the diffs.

tkurki commented 2 months ago

Diff ignoring whitespace changes is better https://github.com/SignalK/specification/pull/664/files?w=1

godind commented 2 months ago

There was no squash commit for some unknown reason.

Maybe read from my fork here: https://github.com/godind/specification/tree/Zones-meta/mdbook/src

Not sure how else to do it but pasting the whole thing here. Or I could create another branch with a single commit.

tkurki commented 2 months ago

The PR is based on that branch so there is no difference whether you look at the PR or the branch.

If you don't squash then there is no squash, just your commits.

But in terms of understanding what has changed squashing or the long list of commits with less than understandable commit messages is not the problem. You have made so many changes to line breaks without changing the content that it is needlessly hard to understand what are the meaningful changes. This is what Scott is asking - the PR description is pretty cryptic. So please can you summarise how and why this PR changes things?

tkurki commented 2 months ago

https://cbea.ms/git-commit/#why-not-how

godind commented 1 month ago

What do you suggest to fix this? I'm not sure how I can resubmit in one change without line breaks. I formatted so I could read myself.

It's a learning curve.

Thanks

tkurki commented 1 month ago

So please can you summarise how and why this PR changes things?

godind commented 1 month ago

Notification changes

Metadata Changes

Please read the output as this is my first spec update. I wrote this based on my exchange with Scott and what I understood. I'm not without fault...

I hope what I wrote helps!