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.

Sign up for GitHub

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

Errata Management Update #2049

Merged
merged 2 commits into from
Sep 19, 2024
+256 −177
Merged

Errata Management Update #2049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2edf74
update errata management to the policy
egekorkan Sep 18, 2024
14e413e
fix footer and TF msention
egekorkan Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
192 changes: 117 additions & 75 deletions errata.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,91 +12,133 @@
</head>

<body>
<header>
<p class="banner"><a accesskey="W" href="/"><img width="72" height="48" alt="W3C"
src="https://www.w3.org/Icons/w3c_home" /></a> </p>
<br />
<h1 class="title">Open Errata for the Web of Things (WoT) Thing Description Specification</h1>

<p class="banner"><a accesskey="W" href="/"><img width="72" height="48" alt="W3C"
src="https://www.w3.org/Icons/w3c_home" /></a> </p>
<br />
<h1 class="title">Open Errata for the Web of Things (WoT) Thing Description Specification</h1>
<dl>
<dt>Latest errata update:</dt>
<dd><span id="date"></span>24 March 2020</dd>
<dt>Number of recorded errata:</dt>
<dd><span id="number"></span>0</dd>
</dl>

<section>

<h2>How to Submit an Erratum?</h2>

<p>
Errata are introduced and stored in the <a href="https://github.com/w3c/wot-thing-description/issues/">issue list
for the WoT Thing Description GitHub repository</a>.
The workflow to add a new erratum is as follows:
</p>

<ol>
<li>
A possible mistake is submitted as issues on GitHub, whose title MUST start
with <code>[POSSIBLE ERRATA]</code>, e.g. <code>[POSSIBLE ERRATA] This sentence is wrong</code>. Anyone can
submit the issue. The specification version MAY be indicated in the issue description.
</li>
<li>
The issue MUST be evaluated before it becomes an official errata, which is reserved for mistakes, errors and
bugs in the REC document.
</li>
<li>
Evaluation of the label MUST happen by the Thing Description Task Force of the Web of Things Working Group.
<ol>
<li>
If this Task Force is not active anymore, the Web of Things Working Group MUST evaluate it.
</li>
<li>
If the Web of Things Working Group does not exist anymore, the W3C Team or their delegated entity MUST
evaluate the submission.
</li>
</ol>
</li>
<li>
Evaluation result MUST be adding a GitHub label with text being either
<code>Official Substantive Errata TD1.0 Confirmed</code> or
<code>Official Editorial Errata TD1.0 Confirmed</code>. Note that whether the errata is substantive or editorial
depends on the errata. If there is implementation impact, it is generally
a substantive errata.
</li>
<li>
If a GitHub issue is submitted without thinking that it can be Errata, thus not contain
<code>[POSSIBLE ERRATA]</code> but turns out to be one, it CAN also obtain the label above after an evaluation
by the Thing Description Task Force of the Web of Things Working Group. Note that the delegation of the Task
Force is NOT REQUIRED to evaluate every new
issue.
</li>
<li>
The Thing Description Task Force of the Web of Things Working Group or their delegation edits the REC document
to address the errata with a GitHub Pull Request also containing
the label <code>Official Errata Fix</code>. In the same Pull Request, the Task Force or the delegation edits the
corresponding errata.html document manually based on the issue, following the instructions below in this
document.
</li>
<li>
Resolution to merge the Pull Request MUST be a Web of Things Working Group resolution or a mechanism chosen by
the delegation.
</li>
</ol>

<p>
If you have problems following this process, but you want nevertheless to report an error, you can also contact
the staff contact of the Web of Things Working Group, <a href="mailto:[email protected]">Kaz Ashimura</a>.
</p>

</section>

<section>
<h2>List of Errata on the "WoT Thing Description" Recommendation</h2>

<dl>
<dt>Latest errata update:</dt>
<dd><span id="date"></span>24 March 2020</dd>
<dt>Number of recorded errata:</dt>
<dd><span id="number"></span>0</dd>
<dt>Latest Published Version:</dt>
<dd><a href="https://www.w3.org/TR/wot-thing-description/">https://www.w3.org/TR/wot-thing-description/</a></dd>
<dt>Editor's draft:</dt>
<dd><a href="https://w3c.github.io/wot-thing-description/">https://w3c.github.io/wot-thing-description/</a></dd>
<dt>Latest Publication Date:</dt>
<dd>2 April 2020</dd>
</dl>

<section>
<h2>How to Submit an Erratum?</h2>
<p>Errata are introduced and stored in the <a href="https://github.com/w3c/wot-thing-description/issues/">issue
list for the WoT Thing Description GitHub repository</a>.
The workflow to add a new erratum is as follows:</p>
<ul>
<li>An issue is raised for a possible erratum. The label of the issue SHOULD be set to
<code>ErratumRaised</code>. It is o.k. for an erratum to have several labels. In some, exceptional, cases,
i.e., when the erratum is very general, it is also acceptable not to have a reference to a document.
</li>
<li>Issues labeled as <code>Editorial</code> are displayed separately, to make it easier to differentiate
editorial errata from substantive ones.</li>
<li>The community discusses the issue. If it is accepted as a genuine erratum, the label <code>Errata</code>
is added to the entry and the <code>ErratumRaised</code> label should be removed. Additionally, a new
comment on the issue MAY be added, beginning with the word "Summary:" (if such a summary is useful based on
the discussion).</li>
<li>If the community rejects the issue as an erratum, the issue should be closed.</li>
<li>Each errata may be labelled as <code>Editorial</code>; editorial errata are listed separately from the
substantive ones.</li>
<li>ALL substantive errata are generally expected to have corresponding test(s), either in the form of new tests
or modifications to existing tests, or must include the rationale for why test updates are not required for
the erratum.</li>
</ul>

<p>This report contains a reference to all open issues with the label <code>Errata</code>, displayed in the
sections below. Each section collects the issues for a specific document, with a separate section for the issues
not assigned to any.</p>

<p>If you have problems following this process, but you want nevertheless to report an error, you can also contact
the staff contact of the Web of Things Working Group, <a href="mailto:[email protected]">Kaz Ashimura</a>.</p>
<h3>Substantive Issues</h3>
<p>None</p>
</section>

<section>
<h2>How to maintain this Document</h2>
<p>
When an errata is accepted, it should be added to this document. When doing so, the maintainers of this document
should follow the steps below:
</p>
<ol>
<li>Add the errata to the bottom of the list at the end of the document that corresponds to the nature of the
errata.</li>
<li>Increment the number of recorded errata at the top of the document.</li>
<li>Update the value of latest errata update at the top of the document</li>
</ol>
<h3>Editorial Issues</h3>
<p>None</p>
</section>
</section>

</header>

<main>

<section>
<h1>Open Errata on the "WoT Thing Description" Recommendation</h1>
<dl>
<dt>Latest Published Version:</dt>
<dd><a href="https://www.w3.org/TR/wot-thing-description/">https://www.w3.org/TR/wot-thing-description/</a></dd>
<dt>Editor's draft:</dt>
<dd><a href="https://w3c.github.io/wot-thing-description/">https://w3c.github.io/wot-thing-description/</a></dd>
<dt>Latest Publication Date:</dt>
<dd>2 April 2020</dd>
</dl>
<section id="first">
<h2>Substantive Issues</h2>
</section>
<section id="last">
<h2>Editorial Issues</h2>
</section>
</section>
</main>
<section>
<h2>How to maintain this Document</h2>
<p>
When an errata is addressed in the REC document, it should be added to this document. When doing so, the
maintainers
of this document should follow the steps below:
</p>
<ol>
<li>
Add the errata to the bottom of the list at the end of the document that corresponds to the nature of the
errata.
</li>
<li>
Increment the number of recorded errata at the top of the document.
</li>
<li>
Update the value of latest errata update date at the top of the document.
</li>
</ol>
</section>

<footer>
<address><a href="mailto:[email protected]" class=''>Kaz Ashimura</a>, &lt;[email protected]&gt;, (W3C)</address>
<div class="footer-copyright text-center ">
Copyright © {{ 'now' | date: "%Y" }} <a href="https://www.w3.org/">World Wide Web Consortium</a>.<br /> <abbr
<footer class="page-footer font-small">
<address><a href="mailto:[email protected]">Web of Things Working Group, Thing Description Task Force</a>,
&lt;[email protected]&gt;</address>
<div class="footer-copyright text-center py-3">
Copyright © 2024 <a href="https://www.w3.org/">World Wide Web Consortium</a>.<br /> <abbr
title="World Wide Web Consortium">W3C</abbr><sup>®</sup> <a
href="https://www.w3.org/policies/#disclaimers">liability</a>, <a
href="https://www.w3.org/policies/#trademarks">trademark</a> and <a rel="license"
Expand Down
Loading