UpdatingLivingStandard

Updating the Living Standard

Previously, we could just make the changes to the draft as needed, and it would eventually get published. However, now that the spec is a living standard, we can no longer do this. Each change needs to be annotated as a correction or addition. For an example of what needs to be done, see Amendment Boxes in the Sample W3C Specification

Adding Amendment Boxes

Each change needs an associated ID. The ID will be of the form "c<n>" or "a<n>", where "c" means this is a correction to spec, and "a" means an addition. "<n>" will be the issue ID for the change.

This makes it easy to have unique IDs that are easy to match to the reason for making the change. The title of the amendment box can have a link to the issue. Finally, the body of the box should have a short description. We can make it short because we have a link to the issue which can have much more information on why this is needed.

Examples

An example of a correction:

<div class="correction" id="c2359">
  <span class="marker">Candidate Correction
    <a href="https://github.com/WebAudio/web-audio-api/issues/2359">Issue 2359.</a>
  </span>
  Fix typo in code; semi-colon is incorrect.
</div>

An addition is similar:

<div class="addition" id="c2359">
  <span class="marker">Candidate Addition
    <a href="https://github.com/WebAudio/web-audio-api/issues/2359">Issue 2359.</a>
  </span>
  Fix typo in code; semi-colon is incorrect.
</div>