Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix "without do cleaning" typo #1572

Closed
wants to merge 1 commit into from
Closed

Conversation

chill389cc
Copy link
Contributor

This pr fixes a simple typo I noticed today while reading documentation here: https://git-scm.com/docs/git-clean#Documentation/git-clean.txt-quit

@gitgitgadget-git
Copy link

Welcome to GitGitGadget

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

Please make sure that your Pull Request has a good description, as it will be used as cover letter. You can CC potential reviewers by adding a footer to the PR description with the following syntax:

CC: Revi Ewer <revi.ewer@example.com>, Ill Takalook <ill.takalook@example.net>

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:

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 git-mentoring@googlegroups.com, 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.

@gitgitgadget-git
Copy link

There are issues in commit 67724bf:
docs: fix "without do cleaning" typo
Commit checks stopped - the message is too short
Commit not signed off

@gitgitgadget-git
Copy link

There are issues in commit 48633f1:
docs: fix "without do cleaning" typo
Commit not signed off

This pr fixes a typo I noticed today while reading documentation here:
https://git-scm.com/docs/git-clean#Documentation/git-clean.txt-quit

Signed-off-by: Caleb Hill <chill389cc@gmail.com>
@chill389cc
Copy link
Contributor Author

chill389cc commented Sep 8, 2023

@kevinbackhouse or @dscho can you /allow me?

@dscho
Copy link
Member

dscho commented Sep 8, 2023

/allow

@gitgitgadget-git
Copy link

User chill389cc is now allowed to use GitGitGadget.

@chill389cc
Copy link
Contributor Author

/submit

@gitgitgadget-git
Copy link

Submitted as pull.1572.git.git.1694800409471.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-1572/chill389cc/master-v1

To fetch this version to local tag pr-git-1572/chill389cc/master-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-1572/chill389cc/master-v1

@gitgitgadget-git
Copy link

This branch is now known as ch/clean-docfix.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via 43f0f0c.

@gitgitgadget-git
Copy link

On the Git mailing list, Junio C Hamano wrote (reply to this):

"Caleb Hill via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Caleb Hill <chill389cc@gmail.com>
>
> This pr fixes a typo I noticed today while reading documentation here:
> https://git-scm.com/docs/git-clean#Documentation/git-clean.txt-quit
>
> Signed-off-by: Caleb Hill <chill389cc@gmail.com>
> ---
>     docs: fix "without do cleaning" typo
>     
>     This pr fixes a simple typo I noticed today while reading documentation
>     here:
>     https://git-scm.com/docs/git-clean#Documentation/git-clean.txt-quit

Thanks; I'll reword the proposed log message a bit and queue.

> diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
> index 160d08b86bb..5e1a3d5148c 100644
> --- a/Documentation/git-clean.txt
> +++ b/Documentation/git-clean.txt
> @@ -127,7 +127,7 @@ ask each::
>  
>  quit::
>  
> -  This lets you quit without do cleaning.
> +  This lets you quit without doing any cleaning.

"without cleaning" would probably mean the same thing and a tad
shorter, but let's use what you wrote as-is.

Thanks.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via bb8fde5.

@gitgitgadget-git
Copy link

There was a status update in the "New Topics" section about the branch ch/clean-docfix on the Git mailing list:

Typofix.

Will merge to 'next'.
source: <pull.1572.git.git.1694800409471.gitgitgadget@gmail.com>

@gitgitgadget-git
Copy link

This patch series was integrated into seen via a40a1b5.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via c7c4670.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via 00df878.

@gitgitgadget-git
Copy link

This patch series was integrated into next via 1e16b71.

@gitgitgadget-git
Copy link

There was a status update in the "Cooking" section about the branch ch/clean-docfix on the Git mailing list:

Typofix.

Will merge to 'master'.
source: <pull.1572.git.git.1694800409471.gitgitgadget@gmail.com>

@gitgitgadget-git
Copy link

This patch series was integrated into seen via 7be1564.

@gitgitgadget-git
Copy link

This patch series was integrated into seen via 8ed1eee.

@gitgitgadget-git
Copy link

This patch series was integrated into master via 8ed1eee.

@gitgitgadget-git
Copy link

This patch series was integrated into next via 8ed1eee.

@gitgitgadget-git
Copy link

Closed via 8ed1eee.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants