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

Fix early wrapping of the command line when using git-prompt.sh and in a git repository #1691

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rquadling
Copy link

No description provided.

Copy link

gitgitgadget bot commented Mar 11, 2024

Welcome to GitGitGadget

Hi @rquadling, 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]>

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

Copy link

gitgitgadget bot commented Mar 11, 2024

There are issues in commit eb1f7b8:
Fix early wrapping of the command line when using git-prompt.sh and in a git repository
Commit checks stopped - the message is too short
First line of commit message is too long (> 76 columns)
Commit not signed off

@dscho
Copy link
Member

dscho commented Mar 11, 2024

/allow

Copy link

gitgitgadget bot commented Mar 11, 2024

User rquadling is now allowed to use GitGitGadget.

@rquadling rquadling force-pushed the master branch 2 times, most recently from 2d5ad4f to d1e4c63 Compare March 11, 2024 15:03
Copy link

gitgitgadget bot commented Mar 11, 2024

There are issues in commit d1e4c63:
Fix early wrapping of the command line when using git-prompt.sh
Commit not signed off

1 similar comment
Copy link

gitgitgadget bot commented Mar 11, 2024

There are issues in commit d1e4c63:
Fix early wrapping of the command line when using git-prompt.sh
Commit not signed off

@dscho
Copy link
Member

dscho commented Mar 11, 2024

Commit not signed off

@rquadling for details what this is all about, see https://git-scm.com/docs/SubmittingPatches#sign-off

Copy link

gitgitgadget bot commented Mar 11, 2024

There are issues in commit bae1e32:
Fix early wrapping of the command line when using git-prompt.sh
Commit not signed off

Copy link

gitgitgadget bot commented Mar 11, 2024

There are issues in commit 626324d:
Fix early wrapping of the command line when using git-prompt.sh
Commit not signed off

When running git-prompt in Bash, the lack of \001 and \002 causes
the command line to wrap early.

The issue is the current \001 and \002 were not themselves escaped
and so resulted in binary 0b1 and 0b10 being present, rather than
the strings "\001" and "\002".

Signed-off-by: Richard Quadling <[email protected]>
@briantracy
Copy link

I am a first time contributor, could you please /allow my PR: #1692

@rquadling
Copy link
Author

I don't really see the point of using email as a way to submit a PR to a repo that has all the functionality already in play.

I found an issue, supplied a PR to the project responsible using a mechanism that is VERY VERY well understood.

Considering the PR is actually on a very remote aspect of the project, it's not worth my time having to subscribe to a mailing list, send one PR, wait for it to be merged, delete all the emails not related to the PR, unsubscribe when the PR is merged.

Considering I've got over 50,000 unread email ... it's all simply too much noise. The Git project has the PR. If they use it, then the issue gets solved. If they don't, then the issue and complaints, and links to gist detailing the fix locally which will get overwritten every time there's an upgrade will just continue.

@dscho
Copy link
Member

dscho commented Apr 8, 2024

The Git project has the PR.

That's incorrect, @rquadling. GitGitGadget is merely a tool trying to help, it is not run by the Git project itself. Therefore, nobody of the Git project had a look at your patch yet, they did not even see it.

@rquadling
Copy link
Author

So what's next? is the PR going to continue on a path to be reviwed/accepted/rejected?

@dscho
Copy link
Member

dscho commented Apr 9, 2024

So what's next? is the PR going to continue on a path to be reviwed/accepted/rejected?

The PR won't go anywhere unless you /submit it, as described here.

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

Successfully merging this pull request may close these issues.

3 participants