How to Submit an Erratum?
Errata are introduced and stored in the issue list of the group‘s 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 SHOULD also include the label corresponding to the document on which the erratum is raised, e.g., “Spec-EPUB3” or “Spec-ReadingSystems” (please, consult the list of available labels; look for labels of the form “Spec-”). 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 substantial 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).
- All issues, labeled by “
Errata”, are displayed in this report, whether they are opened or closed. Their status is added to the report on the individual errata.
- If the community rejects the issue as an erratum, the issue should be closed.
- ALL substantive errata are generally expected to have corresponding tests (such as a pull request in the EPUB 3 Test Repository) 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 Working Group, Ivan Herman.