Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 1.29 KB

bug-report-template.md

File metadata and controls

28 lines (19 loc) · 1.29 KB

Bug Report Template

Summary:

A summary of what the bug is, when it might occur, etc. This might include the types of content affected. This section should provide enough information to give an idea of what is going on.

Scope:

A description of applicable devices/reading systems (including OS, app version numbers, and browser if applicable) as well as whether the issue is observed in-market or sideloaded. For OS, if there is a particular "flavor", please include (ex. Samsung Android v. Pixel Android may yield very different outcomes).

Expected:

Description of the expected behavior (screenshot optional)

Observed:

Description of the observed behavior (screenshot optional)

Code Example:

A snippet of the problematic HTML/XML/CSS

Example Files:

Include an example EPUB file only if you have the rights to do so

Workaround:

Include example code if there is a workaround that you have identified

Example Titles and ISBNs in Market:

Include any example titles with their ISBNS that may be in the marketplace so that RS developers can review the issue

Role in EPUB Ecosystem:

Include your role (content creator, publisher, RS developer, software developer, converter) and what part of the EPUB world you represent (education, trade publishing, what country or continent)