[GSoC/PATCH] t4200: prefer help-functions to "test -(d|f) #595

dinoallo · 2020-03-30T16:01:02Z

Hello again. I thought I needed to improve my commit message since some of community members friendly reminded me last week. So I revised it again. Here is my patch with new commit message.
If there is still something I miss, a reminder will be appreciated.

Signed-off-by: Angel Pan [email protected]

gitgitgadget · 2020-03-30T16:01:46Z

Welcome to GitGitGadget

Hi @dinoallo, 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.

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 "commit:", 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 FreeNode 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.

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

dinoallo · 2020-03-30T16:16:43Z

/allow dinoallo

gitgitgadget · 2020-03-30T16:17:25Z

Error: User dinoallo is not permitted to use GitGitGadget

gitgitgadget · 2020-03-30T16:19:27Z

Error: User dinoallo is not permitted to use GitGitGadget

harry-hov · 2020-03-30T16:35:08Z

Hey mate, you forgot to write commit body. You may want to take a look at this before submitting your patch to the mailing list.
Git really appreciates a descriptive commit message (ps: trust me, I spend days just on commit message).

harry-hov · 2020-03-30T16:35:37Z

/allow

gitgitgadget · 2020-03-30T16:36:34Z

User dinoallo is now allowed to use GitGitGadget.

WARNING: dinoallo has no public email address set on GitHub

dinoallo · 2020-03-30T16:38:04Z

Hey mate, you forgot to write commit body. You may want to take a look at this before submitting your patch to the mailing list.
Git really appreciates a descriptive commit message (ps: trust me, I spend days just on commit message).

Thanks for your help! This is my first time contributing to git project. I appreciate this greatly.

dinoallo · 2020-03-30T17:11:49Z

/preview

gitgitgadget · 2020-03-30T17:13:42Z

Preview email sent as [email protected]

dinoallo · 2020-03-30T17:15:30Z

/submit

gitgitgadget · 2020-03-30T17:16:38Z

Submitted as [email protected]

dscho · 2020-03-30T18:51:34Z

Please do not open new PRs for the same topic. Just force-push and edit the PR description.

dinoallo · 2020-03-30T20:17:56Z

Please do not open new PRs for the same topic. Just force-push and edit the PR description.

Thanks for notice. I finally figured out the way to properly use gitgadget.
Is this has something to do with my previous PRs (the ones that are already closed)?

dinoallo · 2020-04-09T14:21:39Z

/preview

gitgitgadget · 2020-04-09T14:22:34Z

Preview email sent as [email protected]

dinoallo · 2020-04-09T14:42:41Z

/preview

gitgitgadget · 2020-04-09T14:43:41Z

Preview email sent as [email protected]

dinoallo · 2020-04-09T14:53:14Z

/submit

gitgitgadget · 2020-04-09T14:54:42Z

Submitted as [email protected]

gitgitgadget · 2020-04-09T15:23:45Z

On the Git mailing list, Danh Doan wrote (reply to this):

On 2020-04-09 14:54:21+0000, Allo via GitGitGadget <[email protected]> wrote:
> From: Angel Pan <[email protected]>
> 
> Subject: t4200-rerere.sh: use test_path_is_* functions in the script

"in the script" looks too verbose to me. Because the script has been
mentioned earlier.

> The original code works fine. However, since the code base has already had help-functions(in test-lib-functions),

We wrap lines at 72 characters per line.
And, missing space before open parenthese.

I'm not good at wording, but I think this commit message is too
verbose. I would say something like:

	Prefer "test_path_is_dir" to "test -d" and test_path_is_file
	to "test -f" because they're more friendly to debug.

That's not a good message, either. But, it's some what simpler and
cleaner.

> the change is able to help people understand the code better, as well as improve debug-friendliness.
> 
> * t4200-rerere.sh: replace "test -d" with "test_path_is_dir"
> * t4200-rerere.sh: replace "test -f" with "test_path_is_file"
> 

-- 
Danh

gitgitgadget · 2020-04-09T15:40:57Z

There are issues in commit a84a087490ae57a2f5baa92844919cb955c855f7:
First line of commit message is too long (> 76 columns): t4200-rerere.sh: Prefer "test_path_is_dir" to "test -d" and test_path_is_file to "test -f" because they're more friendly to debug.
Prefixed commit message must be in lower case: t4200-rerere.sh: Prefer "test_path_is_dir" to "test -d" and test_path_is_file to "test -f" because they're more friendly to debug.

gitgitgadget · 2020-04-09T15:52:08Z

There are issues in commit a2d0e88c6d3fa8038a147e9058486c607fc92dcb:
First line of commit message is too long (> 76 columns): t4200-rerere: Prefer help-functions to "test -(d|f)" because they're more friendly to debug.
Prefixed commit message must be in lower case: t4200-rerere: Prefer help-functions to "test -(d|f)" because they're more friendly to debug.

gitgitgadget · 2020-04-09T15:58:17Z

There is an issue in commit 56310bf9869b1a27799d47e759e12b897405b931:
Prefixed commit message must be in lower case: t4200: Prefer help-functions to "test -(d|f)"

The original code works fine. However, The code base has already had help-functions(in test-lib-functions), "test -d" and "test -f" are replaced with "test_path_is_dir" and "test_path_is_file" respectively in this commit because they are more friendly to debug. * t4200-rerere.sh: replace "test -d" with "test_path_is_dir" * t4200-rerere.sh: replace "test -f" with "test_path_is_file" Signed-off-by: Angel Pan <[email protected]>

gitgitgadget · 2020-04-09T18:11:49Z

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

Danh Doan <[email protected]> writes:

> On 2020-04-09 14:54:21+0000, Allo via GitGitGadget <[email protected]> wrote:
>> From: Angel Pan <[email protected]>
>> ...
> That's not a good message, either. But, it's some what simpler and
> cleaner.

Thank you, Allo, for a patch, and thank you Danh for a good review.

dinoallo force-pushed the master branch from 40d9f7f to 7e0c874 Compare March 30, 2020 16:51

dinoallo force-pushed the master branch from 7e0c874 to c704627 Compare April 4, 2020 09:27

dinoallo force-pushed the master branch from c704627 to a84a087 Compare April 9, 2020 15:40

dinoallo force-pushed the master branch from a84a087 to a2d0e88 Compare April 9, 2020 15:51

dinoallo force-pushed the master branch from a2d0e88 to 56310bf Compare April 9, 2020 15:57

dinoallo force-pushed the master branch from 56310bf to fc43b73 Compare April 9, 2020 15:59

dinoallo changed the title ~~[GSoC/PATCH] t4200-rerere.sh: use test_path_is_* functions in the script~~ [GSoC/PATCH] t4200: prefer help-functions to "test -(d|f) Apr 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GSoC/PATCH] t4200: prefer help-functions to "test -(d|f) #595

[GSoC/PATCH] t4200: prefer help-functions to "test -(d|f) #595

dinoallo commented Mar 30, 2020 •

edited

Loading

gitgitgadget bot commented Mar 30, 2020

dinoallo commented Mar 30, 2020 •

edited

Loading

gitgitgadget bot commented Mar 30, 2020

gitgitgadget bot commented Mar 30, 2020

harry-hov commented Mar 30, 2020

harry-hov commented Mar 30, 2020

gitgitgadget bot commented Mar 30, 2020

dinoallo commented Mar 30, 2020 •

edited

Loading

dinoallo commented Mar 30, 2020

gitgitgadget bot commented Mar 30, 2020

dinoallo commented Mar 30, 2020

gitgitgadget bot commented Mar 30, 2020

dscho commented Mar 30, 2020

dinoallo commented Mar 30, 2020

dinoallo commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

dinoallo commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

dinoallo commented Apr 9, 2020 •

edited

Loading

gitgitgadget bot commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

[GSoC/PATCH] t4200: prefer help-functions to "test -(d|f) #595

Are you sure you want to change the base?

[GSoC/PATCH] t4200: prefer help-functions to "test -(d|f) #595

Conversation

dinoallo commented Mar 30, 2020 • edited Loading

gitgitgadget bot commented Mar 30, 2020

Welcome to GitGitGadget

Contributing the patches

Need help?

dinoallo commented Mar 30, 2020 • edited Loading

gitgitgadget bot commented Mar 30, 2020

gitgitgadget bot commented Mar 30, 2020

harry-hov commented Mar 30, 2020

harry-hov commented Mar 30, 2020

gitgitgadget bot commented Mar 30, 2020

dinoallo commented Mar 30, 2020 • edited Loading

dinoallo commented Mar 30, 2020

gitgitgadget bot commented Mar 30, 2020

dinoallo commented Mar 30, 2020

gitgitgadget bot commented Mar 30, 2020

dscho commented Mar 30, 2020

dinoallo commented Mar 30, 2020

dinoallo commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

dinoallo commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

dinoallo commented Apr 9, 2020 • edited Loading

gitgitgadget bot commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

gitgitgadget bot commented Apr 9, 2020

dinoallo commented Mar 30, 2020 •

edited

Loading

dinoallo commented Mar 30, 2020 •

edited

Loading

dinoallo commented Mar 30, 2020 •

edited

Loading

dinoallo commented Apr 9, 2020 •

edited

Loading