Git development
 help / color / mirror / Atom feed
* [PATCH] doc: update README file name in my first contribution
@ 2026-11-20 17:04 Ophir Bleicher via GitGitGadget
  2026-11-20 18:24 ` Junio C Hamano
  2026-11-20 18:31 ` [PATCH v2] " Ophir Bleicher via GitGitGadget
  0 siblings, 2 replies; 3+ messages in thread
From: Ophir Bleicher via GitGitGadget @ 2026-11-20 17:04 UTC (permalink / raw)
  To: git; +Cc: Ophir Bleicher, Ophir Bleicher

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(-)

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

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] doc: update README file name in my first contribution
  2026-11-20 17:04 [PATCH] doc: update README file name in my first contribution Ophir Bleicher via GitGitGadget
@ 2026-11-20 18:24 ` Junio C Hamano
  2026-11-20 18:31 ` [PATCH v2] " Ophir Bleicher via GitGitGadget
  1 sibling, 0 replies; 3+ messages in thread
From: Junio C Hamano @ 2026-11-20 18:24 UTC (permalink / raw)
  To: Ophir Bleicher via GitGitGadget; +Cc: git, Ophir Bleicher

"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.

^ permalink raw reply	[flat|nested] 3+ messages in thread

* [PATCH v2] doc: update README file name in my first contribution
  2026-11-20 17:04 [PATCH] doc: update README file name in my first contribution Ophir Bleicher via GitGitGadget
  2026-11-20 18:24 ` Junio C Hamano
@ 2026-11-20 18:31 ` Ophir Bleicher via GitGitGadget
  1 sibling, 0 replies; 3+ messages in thread
From: Ophir Bleicher via GitGitGadget @ 2026-11-20 18:31 UTC (permalink / raw)
  To: git; +Cc: Ophir Bleicher, Ophir Bleicher

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(-)

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

^ permalink raw reply related	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-11-20 18:31 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-20 17:04 [PATCH] doc: update README file name in my first contribution Ophir Bleicher via GitGitGadget
2026-11-20 18:24 ` Junio C Hamano
2026-11-20 18:31 ` [PATCH v2] " Ophir Bleicher via GitGitGadget

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox