threads / patch / 66899

patchdoc: update README file name in my first contribution

Subject: [PATCH] doc: update README file name in my first contribution

## tl;dr

3 messages between Nov 20, 2026 and Nov 20, 2026. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Ophir Bleicher via GitGitGadget· Nov 20, 2026, 17:04 UTC · lore
From: Ophir Bleicher <ophirble@gmail.com>

The translation notice in MyFirstContribution.adoc referenced po/README, but the actual file name is po/README.md. Changed it to po/README.md.

Signed-off-by: Ophir Bleicher <ophirble@gmail.com>
---
    doc: update README file name in my first contribution
    
    The translation notice in MyFirstContribution.adoc referenced po/README,
    but the actual file name is po/README.md. Changed it to po/README.md.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2495%2FOphirBleicher%2Fpatch-2-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2495/OphirBleicher/patch-2-v1
Pull-Request: https://github.com/git/git/pull/2495
 Documentation/MyFirstContribution.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/MyFirstContribution.adoc +1 −1
diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index c58253fd54..29dc402e5a 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -186,7 +186,7 @@ decent starting point as we can now add build rules and register the command.
 
 NOTE: Your throwaway text, as well as much of the text you will be adding over
 the course of this tutorial, is user-facing. That means it needs to be
-localizable. Take a look at `po/README` under "Marking strings for translation".
+localizable. Take a look at `po/README.md` under "Marking strings for translation".
 Throughout the tutorial, we will mark strings for translation as necessary; you
 should also do so when writing your user-facing commands in the future.
 

base-commit: f7de81456940dd6f3274e461149bba12965de609
-- 
gitgitgadget
Junio C Hamano· Nov 20, 2026, 18:24 UTC · re: Ophir Bleicher via GitGitGadget · lore

Re: [PATCH] doc: update README file name in my first contribution

"Ophir Bleicher via GitGitGadget" <gitgitgadget@gmail.com> writes:
> From: Ophir Bleicher <ophirble@gmail.com>
>
> The translation notice in MyFirstContribution.adoc referenced
"references".  We refer to the status quo in the present tense.
> po/README, but the actual file name is po/README.md.
> Changed it to po/README.md.

Have a blank line between the observation and the action. Write the action part as if you are telling an imaginary person what to do, i.e.

"Change it to".
> -localizable. Take a look at `po/README` under "Marking strings for translation".
> +localizable. Take a look at `po/README.md` under "Marking strings for translation".
Looking good.
Will queue with commit message tweaks.
THanks.
Ophir Bleicher via GitGitGadget· Nov 20, 2026, 18:31 UTC · re: Ophir Bleicher via GitGitGadget · lore

[PATCH v2] doc: update README file name in my first contribution

From: Ophir Bleicher <ophirble@gmail.com>

The translation notice in MyFirstContribution.adoc references po/README, but the actual file name is po/README.md.

Change it to po/README.md.
Signed-off-by: Ophir Bleicher <ophirble@gmail.com>
---
    doc: update README file name in my first contribution
    
    The translation notice in MyFirstContribution.adoc referenced po/README,
    but the actual file name is po/README.md. Changed it to po/README.md.
    
    Changes from v1:
    
     * Update commit message grammatical syntax
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2495%2FOphirBleicher%2Fpatch-2-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2495/OphirBleicher/patch-2-v2
Pull-Request: https://github.com/git/git/pull/2495
Range-diff vs v1:
 1:  4e8ec81b21 ! 1:  11905ef191 doc: update README file name in my first contribution
     @@ Metadata
       ## Commit message ##
          doc: update README file name in my first contribution
      
     -    The translation notice in MyFirstContribution.adoc referenced
     +    The translation notice in MyFirstContribution.adoc references
          po/README, but the actual file name is po/README.md.
     -    Changed it to po/README.md.
     +
     +    Change it to po/README.md.
      
          Signed-off-by: Ophir Bleicher <ophirble@gmail.com>
      
 Documentation/MyFirstContribution.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/MyFirstContribution.adoc +1 −1
diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index c58253fd54..29dc402e5a 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -186,7 +186,7 @@ decent starting point as we can now add build rules and register the command.
 
 NOTE: Your throwaway text, as well as much of the text you will be adding over
 the course of this tutorial, is user-facing. That means it needs to be
-localizable. Take a look at `po/README` under "Marking strings for translation".
+localizable. Take a look at `po/README.md` under "Marking strings for translation".
 Throughout the tutorial, we will mark strings for translation as necessary; you
 should also do so when writing your user-facing commands in the future.
 

base-commit: f7de81456940dd6f3274e461149bba12965de609
-- 
gitgitgadget

← back to recent threads