-
Notifications
You must be signed in to change notification settings - Fork 26.4k
Update gitcore-tutorial.adoc #1999
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
base: master
Are you sure you want to change the base?
Conversation
Replace ambiguous asterisk in SYNOPSIS of gitcore-tutorial The SYNOPSIS section previously used a bare asterisk (`git *`) as a placeholder for Git commands. This notation may confuse readers, as the asterisk is widely interpreted in shell contexts as a wildcard, or in regex as repetition. Replacing it with a more explicit and conventional placeholder (`git <command> [<args>...]`) improves clarity without loss of generality. This change aims to make the tutorial more accessible to newcomers while aligning with common documentation practices.
Welcome to GitGitGadgetHi @mutiev, 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:
You can CC potential reviewers by adding a footer to the PR description with the following syntax:
NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description, 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:
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 patchesBefore 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 Both the person who commented An alternative is the channel
Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment If you want to see what email(s) would be sent for a 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 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):
To send a new iteration, just add another PR comment with the contents: 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, |
There are issues in commit 2c61bf8: |
/allow |
User mutiev is now allowed to use GitGitGadget. |
/submit |
There are issues in commit 2c61bf8: |
/submit Update gitcore-tutorial Replace 'git *' with explicit placeholder. Signed-off-by: Mutiev Fedor [email protected] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update gitcore-tutorial
Replace 'git *' with explicit placeholder.
Signed-off-by: Mutiev Fedor [email protected]
@mutiev the commit message itself needs to be amended ( |
Replace ambiguous asterisk in SYNOPSIS of gitcore-tutorial
The SYNOPSIS section previously used a bare asterisk (
git *
) as a placeholder for Git commands. This notation may confuse readers, as the asterisk is widely interpreted in shell contexts as a wildcard, or in regex as repetition. Replacing it with a more explicit and conventional placeholder (git <command> [<args>...]
) improves clarity without loss of generality.This change aims to make the tutorial more accessible to newcomers while aligning with common documentation practices.
_
Update gitcore-tutorial
Replace 'git *' with explicit placeholder.
Signed-off-by: Mutiev Fedor [email protected]