Welcome to GitGitGadget

Hi @SoutrikDas, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that either:

• Your Pull Request has a good description, if it consists of multiple commits, as it will be used as cover letter.
• Your Pull Request description is empty, if it consists of a single commit, as the commit message should be descriptive enough by itself.

You can CC potential reviewers by adding a footer to the PR description with the following syntax:

CC: Revi Ewer <[email protected]>, Ill Takalook <[email protected]>

NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description,
because it will result in a malformed CC list on the mailing list. See
example.

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

• the lines should not exceed 76 columns,
• the first line should be like a header and typically start with a prefix like "tests:" or "revisions:" to state which subsystem the change is about, and
• the commit messages' body should be describing the "why?" of the change.
• Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

• Search: is:pr is:open "/allow"

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the Libera Chat IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this. Note that any reviewers CC'd via the list in the PR description will not actually be sent emails.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

Need help?

New contributors who want advice are encouraged to join [email protected], where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

You may also be able to find help in real time in the developer IRC channel, #git-devel on Libera Chat. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

/allow

User SoutrikDas is now allowed to use GitGitGadget.

WARNING: SoutrikDas has no public email address set on GitHub; GitGitGadget needs an email address to Cc: you on your contribution, so that you receive any feedback on the Git mailing list. Go to https://github.com/settings/profile to make your preferred email public to let GitGitGadget know which email address to use.

/preview

Preview email sent as [email protected]

/preview

Preview email sent as [email protected]

/submit

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-2187/SoutrikDas/doc-fix-myfirstcontribution-config-ref-v1

To fetch this version to local tag pr-git-2187/SoutrikDas/doc-fix-myfirstcontribution-config-ref-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-2187/SoutrikDas/doc-fix-myfirstcontribution-config-ref-v1

My bad for closing this , I had made a small mistake ( I forgot to add a ".h" after a file name in the commit message ) and after correcting that I thought I would have to make another pull request , but it is showing the updated commit message in this pull request only, sorry about this.

Shreyansh Paliwal wrote on the Git mailing list (how to reply to this email):

> Since documentation was moved from Documenation/
> technical/api-config to inside the config.h
> This might help newcomers, by pointing them to the
> right place to get documentation about repo_config

Some suggestions,

* s/Documenation/Documentation

* ~70 cols is the practical followed line wrapping, so you can follow that
for best readability.

* First describe the current problem statement which describes the
current state in the present tense like,

   In MyFirstContribution.adoc, the link to the repo_config()
   documentation is invalid because the documentation related was moved
   to a different file.

* Then you instruct somebody to make changes to the code to make it better like,

   Replace the path for the repo_config() documentation from
   'Documenation/technical/api-config' to 'config.h'.

* Then you can state your additional explainations, references and/or
advantages, whatever seems relevant for the change you just stated.

Best,
Shreyansh

User Shreyansh Paliwal <[email protected]> has been added to the cc: list.

SoutrikDas wrote on the Git mailing list (how to reply to this email):

- Documenation spelling corrected

> First describe the current problem statement which describes the 
> current state in the present tense like 
> "In MyFirstContribution.adoc, the link to the repo_config() 
> documentation is invalid because the documentation related was 
> moved to a different file."

Let this be A 

> Then you instruct somebody to make changes to the code to make it 
> better like 
> Replace the path for the repo_config() documentation from 
> 'Documentation/technical/api-config' to 'config.h'.

Let this be B

So the Commit will be 
> <short tile> 
> 
> <B> 

And the cover mail for that patch will be 
> <short tile same as commit message ? > 
> 
> <A>
>
> <B> 

I configured my git send-email because I couldnt reply to your email
with gitgitgadget ... maybe it was my mistake. Anyway I wanted to ask
Now that I have changed the commit message , what should I do ? 
Should I send a [PATCH v2] as a seperate thread or send it here ?

SoutrikDas wrote on the Git mailing list (how to reply to this email):

In MyFirstContribution.adoc, the link to the repo_config() 
documentation is invalid because the related documentation was moved 
to a different file.

Replace the path for the repo_config() documentation from
'Documentation/technical/api-config.h' to 'config.h'.

Signed-off-by: SoutrikDas <[email protected]>
---
Changes from v1 : 
Corrected Documentation Spelling
Added .h after api-config
Changed Commit message to suit git's style
---
 Documentation/MyFirstContribution.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index f186dfbc89..92de476a7f 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -351,7 +351,7 @@ function body:
 apply standard precedence rules. `repo_config_get_string_tmp()` will look up
 a specific key ("user.name") and give you the value. There are a number of
 single-key lookup functions like this one; you can see them all (and more info
-about how to use `repo_config()`) in `Documentation/technical/api-config.adoc`.
+about how to use `repo_config()`) in `config.h`.
 
 You should see that the name printed matches the one you see when you run:
 
-- 
2.50.1 (Apple Git-155)

Junio C Hamano wrote on the Git mailing list (how to reply to this email):

SoutrikDas <[email protected]> writes:

> In MyFirstContribution.adoc, the link to the repo_config() 
> documentation is invalid because the related documentation was moved 
> to a different file.
>
> Replace the path for the repo_config() documentation from
> 'Documentation/technical/api-config.h' to 'config.h'.

OK.  I eyeballed output from

    $ git grep 'Documentation/technical/.*\.adoc' Documentation/

and everything else mentioned are still there.

Thanks.

>
> Signed-off-by: SoutrikDas <[email protected]>
> ---
> Changes from v1 : 
> Corrected Documentation Spelling
> Added .h after api-config
> Changed Commit message to suit git's style
> ---
>  Documentation/MyFirstContribution.adoc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
> index f186dfbc89..92de476a7f 100644
> --- a/Documentation/MyFirstContribution.adoc
> +++ b/Documentation/MyFirstContribution.adoc
> @@ -351,7 +351,7 @@ function body:
>  apply standard precedence rules. `repo_config_get_string_tmp()` will look up
>  a specific key ("user.name") and give you the value. There are a number of
>  single-key lookup functions like this one; you can see them all (and more info
> -about how to use `repo_config()`) in `Documentation/technical/api-config.adoc`.
> +about how to use `repo_config()`) in `config.h`.
>  
>  You should see that the name printed matches the one you see when you run:

This branch is now known as sd/doc-my1c-api-config-reference-fix.

This patch series was integrated into seen via be5f759.

This patch series was integrated into seen via 07bf445.

This patch series was integrated into seen via 4fa0393.

This patch series was integrated into seen via 0971f22.

This patch series was integrated into seen via 4fa0393.

This patch series was integrated into seen via 0a8d2fb.

This patch series was integrated into next via 222e701.

There was a status update in the "New Topics" section about the branch sd/doc-my1c-api-config-reference-fix on the Git mailing list:

Docfix.

Will merge to 'master'.
source: <[email protected]>

This patch series was integrated into seen via b541b0e.

This patch series was integrated into seen via 35c1444.

This patch series was integrated into seen via 7565f4a.

There was a status update in the "Cooking" section about the branch sd/doc-my1c-api-config-reference-fix on the Git mailing list:

Docfix.

Will merge to 'master'.
source: <[email protected]>

This patch series was integrated into seen via b20162a.

This patch series was integrated into seen via 94336d7.

This patch series was integrated into master via 94336d7.

This patch series was integrated into next via 94336d7.

Closed via 94336d7.