How to Submit an Erratum?
Errata are introduced and stored in the issue list for
the WoT Thing Description GitHub repository.
The workflow to add a new erratum is as follows:
- An issue is raised for a possible erratum. The label of the issue SHOULD be set to
ErratumRaised
. 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.
- Issues labeled as
Editorial
are displayed separately, to make it easier to differentiate
editorial
errata from substantive ones.
- The community discusses the issue. If it is accepted as a genuine erratum, the label
Errata
is added to the entry and the ErratumRaised
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).
- If the community rejects the issue as an erratum, the issue should be closed.
- Each errata may be labelled as
Editorial
; editorial errata are listed separately from the
substantive ones.
- 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.
This report contains a reference to all open issues with the label Errata
, 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.
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, Kaz Ashimura.