From e6a55211a9ad45b0f99551e2c031b2843e89c905 Mon Sep 17 00:00:00 2001 From: Phil Crooker <50255776+pcrooker@users.noreply.github.com> Date: Sat, 8 Jan 2022 12:46:56 +1100 Subject: [PATCH] changing first commit and Editorial commit descriptions (#155) --- www/contribute/producing-an-ebook-step-by-step.php | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/www/contribute/producing-an-ebook-step-by-step.php b/www/contribute/producing-an-ebook-step-by-step.php index a0d3e61e..0b11d8b1 100644 --- a/www/contribute/producing-an-ebook-step-by-step.php +++ b/www/contribute/producing-an-ebook-step-by-step.php @@ -110,7 +110,9 @@ require_once('Core.php'); proceed to seal up my confession, I bring the life of that unhappy Henry Jekyll to an end. </p>

Now that we’ve removed all the cruft from the top and bottom of the file, we’re ready for our first commit.

-

Please use the following commit message for consistency with the rest of our ebooks:

git add -A git commit -m "Initial commit" +

Each commit has an accompanying message describing the changes we are making. Please use the commit messages as they are written here in this guide as the editors rely on these messages when they review the work.

+

Also, try to make one commit per type of change, for example: “fixing typos in chapters 1-18” or “worked on letter formatting.”

+

For this first commit:

git add -A git commit -m "Initial commit"

  • Split the source text at logical divisions

    @@ -450,8 +452,11 @@ proceed to seal up my confession, I bring the life of that unhappy Henry Jekyll se interactive-replace "([Mm])ean time" "\1eantime" src/epub/text/*
    • -

    After you’ve reviewed the changes, create an [Editorial] commit. This commit is important, because it gives purists an avenue to revert modernizing changes to the original text.

    -

    Note how we preface this commit with [Editorial]. Any change you make to the source text that can be considered a modernization or editorial change should be prefaced like this, so that the git history can be easily searched by people looking to revert changes.

    +

    After you’ve reviewed the changes, create an [Editorial] commit. This type of commit is important, because it gives purists an avenue to reverse these changes back to the original text.

    + git commit -am "[Editorial] Modernize hyphenation and spelling"