mbox series

[Outreachy,0/1] builtin/branch.c: ammend die() error message

Message ID 20231011152424.6957-1-isokenjune@gmail.com (mailing list archive)
Headers show
Series builtin/branch.c: ammend die() error message | expand

Message

Isoken June Ibizugbe Oct. 11, 2023, 3:24 p.m. UTC
This patch improves the consistency and clarity of error messages across Git commands. It adheres to Git's Coding Guidelines for error messages:

- Error messages no longer end with a full stop.
- Capitalization is avoided in error messages.
- Error messages lead with a description of the issue, enhancing readability.

Signed-off-by: Isoken June Ibizugbe <isokenjune@gmail.com>

Isoken June Ibizugbe (1):
  branch.c: ammend error messages for die()

 builtin/branch.c | 38 +++++++++++++++++++-------------------
 1 file changed, 19 insertions(+), 19 deletions(-)

Comments

Dragan Simic Oct. 11, 2023, 3:34 p.m. UTC | #1
On 2023-10-11 17:24, Isoken June Ibizugbe wrote:
> This patch improves the consistency and clarity of error messages
> across Git commands. It adheres to Git's Coding Guidelines for error
> messages:
> 
> - Error messages no longer end with a full stop.
> - Capitalization is avoided in error messages.
> - Error messages lead with a description of the issue, enhancing 
> readability.
> 
> Signed-off-by: Isoken June Ibizugbe <isokenjune@gmail.com>

When there's only one patch and not a series, there's no need for a 
cover letter, and the description of the patch actually needs to go into 
the patch itself, so it can be latter pulled into the repository as part 
of the patch submission.

> Isoken June Ibizugbe (1):
>   branch.c: ammend error messages for die()
> 
>  builtin/branch.c | 38 +++++++++++++++++++-------------------
>  1 file changed, 19 insertions(+), 19 deletions(-)
Dragan Simic Oct. 11, 2023, 3:46 p.m. UTC | #2
On 2023-10-11 17:42, Isoken Ibizugbe wrote:
> Thanks for the feedback. How do I add the description of the patch.

Could you, please, use inline replying?  We've asked that at least four 
times already.

Regarding the description of the patch, just write it as the commit 
comment in your local git repository.  Using git-format-patch will pick 
the commit comment up and put it into the email message file you'll then 
send to the mailing list using git-send-email.  It's all rather simple 
and straightforward.


> On Wed, 11 Oct 2023 at 4:34 PM, Dragan Simic <dsimic@manjaro.org>
> wrote:
> 
>> On 2023-10-11 17:24, Isoken June Ibizugbe wrote:
>>> This patch improves the consistency and clarity of error messages
>>> across Git commands. It adheres to Git's Coding Guidelines for
>> error
>>> messages:
>>> 
>>> - Error messages no longer end with a full stop.
>>> - Capitalization is avoided in error messages.
>>> - Error messages lead with a description of the issue, enhancing
>>> readability.
>>> 
>>> Signed-off-by: Isoken June Ibizugbe <isokenjune@gmail.com>
>> 
>> When there's only one patch and not a series, there's no need for a
>> cover letter, and the description of the patch actually needs to go
>> into
>> the patch itself, so it can be latter pulled into the repository as
>> part
>> of the patch submission.
>> 
>>> Isoken June Ibizugbe (1):
>>> branch.c: ammend error messages for die()
>>> 
>>> builtin/branch.c | 38 +++++++++++++++++++-------------------
>>> 1 file changed, 19 insertions(+), 19 deletions(-)