From: Junio C Hamano <gitster@pobox.com>
To: Isoken June Ibizugbe <isokenjune@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 1/1] branch.c: ammend error messages for die()
Date: Wed, 11 Oct 2023 10:29:29 -0700 [thread overview]
Message-ID: <xmqqa5spm5ja.fsf@gitster.g> (raw)
In-Reply-To: <20231011152424.6957-2-isokenjune@gmail.com> (Isoken June Ibizugbe's message of "Wed, 11 Oct 2023 16:24:20 +0100")
Isoken June Ibizugbe <isokenjune@gmail.com> writes:
> Subject: Re: [PATCH 1/1] branch.c: ammend error messages for die()
"ammend" is misspelt, but more importantly, it has less information
contents than other possible phrases, e.g.,
Subject: [PATCH 1/1] branch.c: adjust die() messages to coding guidelines
In any case, the title of a commit has insufficient space to
describe what the amendment is about, or which exact guideline
these messages violate and needs adjustment. This space before your
sign-off is where you write it.
Other outreachy candidates have already been given pretty much the
same pieces of advice. It may help candidates to learn from the
responses given to other candidates. For example, I said the same
thing in https://lore.kernel.org/git/xmqqlecbzl5e.fsf@gitster.g/
> Signed-off-by: Isoken June Ibizugbe <isokenjune@gmail.com>
> ---
> builtin/branch.c | 38 +++++++++++++++++++-------------------
> 1 file changed, 19 insertions(+), 19 deletions(-)
Not a fault of this patch at all, but it is somewhat surprising that
we do not break any existing test with this many messages changed.
Did you run the test suite before making this commit?
Make it a habit to always do "make test" before committing your
work. I am not saying "do not commit what does not pass the tests".
What I mean is "be aware of what is still broken (when fixing a bug)
or what you broke (when adding a new feature, perhaps as an
unintended side effect), before you commit, so that you can describe
them in your commit log message".
Thanks.
next prev parent reply other threads:[~2023-10-11 17:29 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-11 15:24 [Outreachy][PATCH 0/1] builtin/branch.c: ammend die() error message Isoken June Ibizugbe
2023-10-11 15:24 ` [PATCH 1/1] branch.c: ammend error messages for die() Isoken June Ibizugbe
2023-10-11 17:29 ` Junio C Hamano [this message]
2023-10-11 18:04 ` Rubén Justo
2023-10-11 19:10 ` Junio C Hamano
2023-10-12 5:31 ` Isoken Ibizugbe
2023-10-11 15:34 ` [Outreachy][PATCH 0/1] builtin/branch.c: ammend die() error message Dragan Simic
[not found] ` <CAJHH8bGOSXNNYfOCkS=ck8r-=Mbq62Rs1c4NsgFWYD999kNfRw@mail.gmail.com>
2023-10-11 15:46 ` Dragan Simic
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqa5spm5ja.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=isokenjune@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).