-
NO ARTISTIC/AESTHETIC CHANGES PLEASE! We're only interested in content updates and corrections, or updated screenshots that show new menus or new features. If you're hoping to "jazz things up" or redo the the style of the epub to reflect your personal style or formatting preferences, you're probably going to be disappointed. Pull Requests that include stylistic changes or "upgrades" will be declined (unless such work has been pre-approved of course).
-
Less is best. Several smaller, tightly focused Pull Requests are always going to be preferred over ones that represent grand, sweeping changes to large swathes of the manual. We don't want to have to read the entire manual each and every time we're evaluating a new Pull Request. Neither would you. Be considerate if you want to see your efforts incorporated.
-
Don't Break anything. Changes that break the resulting epub or cause validation issues will be rejected. It's your responsibility to make sure the epub structure remains intact and spec compliant.
-
Fork this repository to your own Github account and clone a local copy of it to your computer.
-
Use the FolderIn Sigil plugin to load the contents of the "src" directory of your local, cloned repository into Sigil.
-
Make sure you have the non-breaking space entity ( ) in your Epub3 Preserve Entities preference list.
-
Make sure you are using the default prettyprint.xml file in your Sigil preference folder. If you have modified how Prettify works vis this file (in Sigil's prefs folder), backup your custom prettyprint.xml file up somewhere safe, delete the existing one in Sigil's preferences folder, and restart Sigil (it will create a new default prettyprint.xml). You can restore your custom one from your backup after done editing the guide.
-
Do your editing. Remember to use "Mend and Prettify" (on only the files you've modified!), and always make sure the epub validates with no errors. Then when ready, save the contents back to the "src" directory of your local, cloned repository using the FolderOut Sigil plugin.
-
Use the normal git tools to check your differences and then when satisfied, commit and push your changes to your Github fork.
-
Create a new Pull Request from your Github account so that we can review and hopefully pull your changes into the project.
-
NOTE: There is no need to save a copy of the edited epub unless you need to preserve your editing session and come back to it before writing it back to the repo using FolderOut.
If you run into trouble, feel free to ask for help at the Sigil Support forums on Mobileread.