solid / notifications

Solid Notifications Technical Reports
https://solid.github.io/notifications/protocol
MIT License
11 stars 7 forks source link

Update changelog detailing Classes of Changes #181

Closed csarven closed 1 year ago

csarven commented 1 year ago

Happy solstice!

This PR is a https://www.w3.org/2023/Process-20230612/#class-2 change in the specification updating the #changelog section in the following ways:

This approach to the changelog was demo'd in Test Suite Panel 2023-04-18 meeting: https://github.com/solid/test-suite-panel/blob/main/meetings/2023-04-18.md - the minutes do not capture the details of the live demo) as part of the Solid QA work and deemed to be useful in specifications.

To help the PR reviewers, detailed information on "Classes of Changes" were originally introduced in some Solid PRs, e.g.:

A link to the diff view was also used in numerous PRs, e.g., https://github.com/solid/specification/pull/491 (as well as inspired by W3C Process's own Changes)

Hence, the approach here is the initial codification of the practise across W3C Process, Spec Terms, PR information for use in the specification. PRs introducing editorial, substantive, and registry changes can continue to mention the correction class in the PR description.


Merging this PR as it updates the non-normative section, and with some preference to get this initial approach going as is. Still, feedback and improvements are most welcome!

csarven commented 1 year ago

Use: dokieli-diff-requirements-change . Live / accessible from https://solid.github.io/notifications/protocol . Information in spec:Changelog is used in the diff view of dokieli where the requirements meet.

While implementing its consumption, I've noticed that the changelog section (table) did not originally include some of the changes that were made to the requirement. So, the tool helped me, as an editor/author to include that change information.