Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update changelog detailing Classes of Changes #536

Merged
merged 1 commit into from
Jun 21, 2023
Merged

Conversation

csarven
Copy link
Member

@csarven csarven commented Jun 21, 2023

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:

  • Detailed use of language and links from W3C Process Document's Classes of Changes in the changelog.
  • Uses a table with columns Change Class, Subject, and Description to further detail editorial, substantive, registry changes in the specification since the previous version. Each row in the table corresponds to a specific "change".
  • Adds link to list of issued addressed.
  • Adds link to W3C diff service between this version and previous version.
  • Adds link to GitHub for detailed log of changes.
  • Adds link to changelog of previous version to discover earlier versions.
  • All change information is machine-readable (RDF) and expressed using Spec Terms.

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. See also solid/notifications#181 where this approach is also applied on Solid Notifications Protocol: https://solid.github.io/notifications/protocol

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., #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 csarven added this to the Release 0.11.0 milestone Jun 21, 2023
@csarven csarven self-assigned this Jun 21, 2023
@csarven csarven merged commit 8823c48 into main Jun 21, 2023
@csarven csarven deleted the feature/spec-change branch June 21, 2023 13:51
@csarven
Copy link
Member Author

csarven commented Jun 21, 2023

Use: dokieli-diff-requirements-change-protocol . Live / accessible from https://solidproject.org/ED/protocol . Information in spec:Changelog is used in the diff view of dokieli where the requirements meet.

See also solid/notifications#181 (comment)

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant