CINXE.COM
Errata, Fixes and Bug Reports | Project Gutenberg
<!DOCTYPE html> <html class="client-nojs" lang="en" dir="ltr"> <head> <meta charset="UTF-8"/> <title>Errata, Fixes and Bug Reports | Project Gutenberg</title> <link rel="stylesheet" href="/gutenberg/style.css?v=1.1"> <link rel="stylesheet" href="/gutenberg/collapsible.css?1.1"> <link rel="stylesheet" href="/gutenberg/new_nav.css?v=1.321231"> <link rel="stylesheet" href="/gutenberg/pg-desktop-one.css"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="keywords" content="books, ebooks, free, kindle, android, iphone, ipad"/> <meta name="google-site-verification" content="wucOEvSnj5kP3Ts_36OfP64laakK-1mVTg-ptrGC9io"/> <meta name="alexaVerifyID" content="4WNaCljsE-A82vP_ih2H_UqXZvM"/> <link rel="copyright" href="https://www.gnu.org/copyleft/fdl.html"/> <link rel="icon" type="image/png" href="/gutenberg/favicon.ico" sizes="16x16" /> <meta property="og:title" content="Project Gutenberg" /> <meta property="og:type" content="website" /> <meta property="og:url" content="https://www.gutenberg.org/" /> <meta property="og:description" content="Project Gutenberg is a library of free eBooks." /> <meta property="fb:admins" content="615269807" /> <meta property="fb:app_id" content="115319388529183" /> <meta property="og:site_name" content="Project Gutenberg" /> <meta property="og:image" content="https://www.gutenberg.org/gutenberg/pg-logo-144x144.png" /> </head> <body> <div class="container"><!-- start body --><nav> <!--<div id="main_logo"> --> <a id="main_logo" href="/" class="no-hover"> <img src="/gutenberg/pg-logo-129x80.png" alt="Project Gutenberg" draggable="false" /> </a> <!-- </div>--> <div id="menu"> <label for="tm" id="toggle-menu">Menu<span class="drop-icon">▾</span></label> <input type="checkbox" id="tm" /> <ul class="main-menu cf"> <li> <a href="/about/">About <span class="drop-icon">▾</span> </a> <label title="Toggle Drop-down" class="drop-icon" for="sm0">▾</label> <input type="checkbox" id="sm0" /> <ul class="sub-menu"> <li><a href="/about/">About Project Gutenberg</a></li> <li><a href="/policy/collection_development.html">Collection Development</a></li> <li><a href="/about/contact_information.html">Contact Us</a></li> <li><a href="/about/background/">History & Philosophy</a></li> <li><a href="/policy/permission.html">Permissions & License</a></li> <li><a href="/policy/privacy_policy.html">Privacy Policy</a></li> <li><a href="/policy/terms_of_use.html">Terms of Use</a></li> </ul> </li> <li> <a href="/ebooks/">Search and Browse <span class="drop-icon">▾</span> </a> <label title="Toggle Drop-down" class="drop-icon" for="sm8">▾</label> <input type="checkbox" id="sm8" /> <ul class="sub-menu"> <li><a href="/ebooks/">Book Search</a></li> <li><a href="/ebooks/bookshelf/">Bookshelves</a></li> <li><a href="/browse/scores/top">Frequently Downloaded</a></li> <li><a href="/ebooks/offline_catalogs.html">Offline Catalogs</a></li> </ul> </li> <li> <a href="/help/">Help <span class="drop-icon">▾</span> </a> <label title="Toggle Drop-down" class="drop-icon" for="sm3">▾</label> <input type="checkbox" id="sm3" /> <ul class="sub-menu"> <li><a href="/help/">All help topics →</a></li> <li><a href="/help/copyright.html">Copyright How-To</a></li> <li><a href="/help/errata.html">Errata, Fixes and Bug Reports</a></li> <li><a href="/help/file_formats.html">File Formats</a></li> <li><a href="/help/faq.html">Frequently Asked Questions</a></li> <li><a href="/policy/">Policies →</a></li> <li><a href="/help/public_domain_ebook_submission.html">Public Domain eBook Submission</a></li> <li><a href="/help/submitting_your_own_work.html">Submitting Your Own Work</a></li> <li><a href="/help/mobile.html">Tablets, Phones and eReaders</a></li> <li><a href="/attic/">The Attic →</a></li> </ul> </li> <li><a href="/donate/">Donate</a></li> </ul> </div> <div class="donate"> <div class="searchbox"> <form method="get" action="/ebooks/search/" accept-charset="utf-8" enctype="multipart/form-data" class="searchbox"> <input type="text" value="" id="menu-book-search" name="query" class="searchInput" title="Quick search" tabindex="20" size="20" maxlength="80" placeholder=" Quick search" /> <input type="submit" name="submit_search" value="Go!" style="vertical-align:middle;" /> </form> </div> <form class="donatelink" action="https://www.paypal.com/cgi-bin/webscr" method="post" target="new"> <p><a href="/donate/">Ways to donate</a></p> <input type="hidden" name="cmd" value="_s-xclick" /> <input type="hidden" name="hosted_button_id" value="XKAL6BZL3YPSN" /> <input class="donbtn" type="image" src="/pics/en_US.gif" name="submit" alt="Donate via PayPal" /> </form> </div> </nav> <div class="page_content"><!-- start content --> <h1 id="submitting-errata-fixes-and-bug-reports">Submitting Errata, Fixes and Bug Reports</h1> <p>Errata reports, typos, etc. are welcome and appreciated. Email reports to errata2024 @ pglaf.org (remove the spaces around the @). Suggested formats for reports are described below.</p> <p>For many books, you may also submit corrections, typos, etc. by making “pull requests” on <a href="https://github.com/gutenbergbooks">GitHub</a>. See “Corrections to posted books using pull requests to GitHub,” below. It is expected that nearly all books will have repositories by the end of October 2024. If you would like to use the process for a book that doesn’t yet have a repo send an email requests for the repo to be created to errata2024 @ pglaf.org.</p> <p>Corrections should be against the main source(s) of the Project Gutenberg books. These are usually found under the “more files” link on the landing page, and are almost always a plain text (*.txt) and an HTML (.htm) file. The links at the top of landing pages (such as https://www.gutenberg.org/928) are generated from the files under “more files” (lower down on the landing page under the table of different file formats). It’s best to submit errata reports against those files.</p> <h2 id="corrections-to-posted-books-using-email">Corrections to posted books using email</h2> <p>It is important to report the full title, author, and eBook number of the text you are correcting. We have multiple editions of some texts, like Homer’s “Odyssey,” and unless you tell us exactly what eBook you mean we have to spend much time searching and guessing which file you were reading. It is important to specify that you are reporting errors found in the text, html, .mobi or .epub file.</p> <p>It is usually easiest to cut and paste the line where the error is into your e-mail, with your comment.</p> <p>A report for a typical errata list might look like:</p> <pre> The Odyssey, by Homer April, 1999 [EBook #1728] Line 884: back Telemachus, who bas now resided there for a month. "bas" should be "has" Line 1491: Ithaca yet stands. But I wouldask thee, friend, concerning "would" and "ask" are run together here Line 1563: in his father's seat and the elders gave place to him This is the end of a paragraph, and needs a period at end. Line 15346-7: 'Hearken to me now, ye men of Ithaca, to the will say. Through your own cowardice, my friends, have I think there is something missing between "the" and "will" </pre> <p>But the following gets the job done:</p> <pre> In Homer's Odyssey, EBook #1728, I found the following errors: Telemachus, who bas now resided change "bas" to "has" But I wouldask thee, "would ask" run together and the elders gave place to him needs period ye men of Ithaca, to the will say. line missing between "the" and "will"? </pre> <p>Or, even shorter and easiest to use:</p> <pre> In Homer's "Odyssey," EBook #1728, I found the following errors: Telemachus, who bas now resided bas ==> has But I wouldask thee, wouldask ==> would ask and the elders gave place to him him ==> him. ye men of Ithaca, to the will say. line or words missing between "the" and "will"? </pre> <p>The common error of copying several lines or the entire paragraph which contains the error followed by the same paragraph with the error corrected makes it very difficult and time consuming for the editor to locate the error. Please use one of the errata report formats above.</p> <p>On the other hand it is also important to give a long enough portion of the line with the error as there may be dozens of instances of a short phrase.</p> <p>For example:</p> <pre> to him him ==> him. </pre> <p>may take 10 minutes or more of the editor’s time searching for “to him” if there are 100 instances of “to him” in the eBook.</p> <p>Experienced Project Gutenberg contributors may find that when there are a great many suspected errors it may be easiest all round just to submit a corrected version of the text and html files.</p> <p>If you are a regular, and have used any of the standard Gutenberg tools like “Gutcheck” or “Jeebies” to find errors, you might mention something like: “Gutcheck finds a lot of bad quotes”.</p> <p>When you are able to find the eBook’s title in an online eBook such as “The Internet Archive,” it is a great help to us if you verify your suggested changes and in your report let us know you have done so and the source used.</p> <p>Any errata submissions are freely made, without obligation, and are entirely in the public domain.</p> <h2 id="corrections-to-posted-books-using-pull-requests-to-github">Corrections to posted books using pull requests to GitHub</h2> <p>Many books in the Project Gutenberg collection have GitHub repositories of their public domain content. To have a repo, a book must:</p> <ul> <li>Be in the public domain in the US. This excludes a few hundred copyrighted books in the collection.</li> <li>Be dominantly textual. This excludes around a thousand audiobooks and other formats.</li> <li>Be available in one of these formats: plain text, HTML, RST, or TeX (and variants like LaTeX). This excludes a small number of books in uncommon formats. You might need to update the format to be one of these, before issuing a pull request.</li> </ul> <p>A “pull request” is jargon for using the “git” revision control system to propose changes. Basically, you will be making a copy of the file(s) containing Project Gutenberg books, making changes to fix those files, then proposing those changes back to the Project Gutenberg repository.</p> <p>Here is an overview of the process:</p> <ul> <li>“clone” a copy of the current files into your own workspace on GitHub</li> <li>make corrections that you want to suggest</li> <li>make a pull request to the maintainers of the PG repositories</li> </ul> <p>A “pull request” means you want Project Gutenberg to “pull” your corrections from the corrected copy you submitted and merge those corrections into the posted eBook. Once your corrections have been incorporated, the book will be reposted and you will be notified.</p> <p>To use this process, you need a free account at <a href="https://github.com">GitHub</a> if you don’t have one already. The process is straightforward, as described in the GitHub documentation. Once you have an account, you will clone the eBook to your account.</p> <p>Project Gutenberg’s eBooks are stored in GitHub in the “gutenbergbooks” organization. If you wanted to suggest a correction to eBook 22196, for example, you would clone the repository from https://github.com/gutenbergbooks/22196.</p> <p>Typically you then will use the built-in editor provided in the browser on the GitHub site to make corrections. Another way is to download your cloned repository to your home machine and use a tool such as “Git for Windows” to make the corrections.</p> <p>Once corrections are made, “push” the version from your home machine back to your account on GitHub. Wherever you make corrections, the final step will be to make a pull request against the Project Gutenberg repository. You will be informed by emails from PG, via github, of the progress from there and the eventual reposting of the book.</p> <p>Any errata submissions via pull requests are freely made, without obligation, and are entirely in the public domain.</p> <p>If you are not sure whether your pull request was received, or need guidance on the process, email errata2024 @ pglaf.org.</p> </div><!--content ending--> </div><!-- body ending --> <div class="footer"><!-- start footer --> <ul> <li> <a href="/policy/privacy_policy.html" title="Privacy Policy">Privacy policy</a> </li> <li> <a href="/about/" title="About Project Gutenberg">About Project Gutenberg</a> </li> <li> <a href="/policy/terms_of_use.html" title="Terms of Use">Terms of Use</a> </li> <li> <a href="/about/contact_information.html" title="Contact Information">Contact Information</a> </li> <li><a href="/help/" title="Get Help">Get Help</a></li> </ul> <a href="https://www.ibiblio.org/" title="Project Gutenberg is hosted by ibiblio"> <img src="/gutenberg/ibiblio-logo.png" alt="iBiblio"> </a> </div><!-- footer ending--> </body> </html>