w3c / w3c/process

FPWD → CRS transition has onerous change documentation requirements

Open
#727 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
262
Forks
194
PR merge metrics
No merged PRs in 30d

Description

For the first transition to CR, the transition requirements include:

  • documenting all classes 4 changes (new features)
  • documenting all classes 3 changes (substantive changes)
  • optionally documenting all other changes

While this feels meaningful for transitions post 1st-CR, it feels onerous and not very meaningful for the first CR transition, since in most cases one would expect a lot of such changes between FPWD and CRS (unless "since previous publication" is meant literally as since the previous WD rather than what I think is meant as "since previous transition" - but then that would be meaningless, esp in a world of automatic publications).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked transition requirements, focusing on the FPWD-to-CRS wording and the meaning of “since previous publication.” Compare that requirement with the intended first-CR transition workflow; the work is done when the requirement’s interpretation or wording has been resolved and reflected in the Process Document.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.