注册每日送分的电玩城

useful topics and commit messages within git commits on webwml repository

classic Classic list List threaded Threaded
10 messages Options
Reply | Threaded
Open this post in threaded view
|

useful topics and commit messages within git commits on webwml repository

Carsten Schoenert
Hello Sebul,

I noticed you constantly use only one word for documenting your commits
within the webwml repository. E.g.

> $ git show 7dc100 b9aab8 bdeee6 --shortstat
> commit 7dc1005a769339b4d37a2a661f73ee197edaece1
> Author: Sebul <[hidden email]>
> Date:   Sat Feb 22 14:21:18 2020 +0900
>
>     4631
>
>  1 file changed, 23 insertions(+)
>
> commit b9aab8bf143922068d02cdc835908a062944914c
> Author: Sebul <[hidden email]>
> Date:   Wed Feb 19 21:28:12 2020 +0900
>
>     8
>
>  1 file changed, 20 insertions(+)
>
> commit bdeee6693fc19bcd7cdca2caf399771344796848
> Author: Sebul <[hidden email]>
> Date:   Wed Feb 19 21:25:58 2020 +0900
>
>     webkit
>
>  1 file changed, 47 insertions(+)

This kind of doing commits makes it nearly impossible to follow and
understand the additions you are doing. Everybody needs to have also a
look into the details of your commit to see what you have done. That's
bad because it's costs time on the others side, by this it makes the
work other people do more inefficient.
The current way you doing commit messages makes the usage of the git log
command useless.

Could you please adjust your workflow in the future to make an useful
usage of the topic/subject and if needed of the body of the git commit?
Thanks for consideration!

For example you could use one of the following stanza for the subject
(as other contributors already doing so).

(Korean) DSA-4631-1 pillow
(ko) [DSA 4631-1] pillow security update

--
Regards
Carsten Schoenert

Reply | Threaded
Open this post in threaded view
|

Re: useful topics and commit messages within git commits on webwml repository

sebul
Is there a problem?
These are Korean translations.
I'm Korean tranlation coordinator.
Who can help Korean translation ?

Thank you.



On Sat, Feb 22, 2020, 18:02 Carsten Schoenert <[hidden email]> wrote:
Hello Sebul,

I noticed you constantly use only one word for documenting your commits
within the webwml repository. E.g.

> $ git show 7dc100 b9aab8 bdeee6 --shortstat
> commit 7dc1005a769339b4d37a2a661f73ee197edaece1
> Author: Sebul <[hidden email]>
> Date:   Sat Feb 22 14:21:18 2020 +0900
>
>     4631
>
>  1 file changed, 23 insertions(+)
>
> commit b9aab8bf143922068d02cdc835908a062944914c
> Author: Sebul <[hidden email]>
> Date:   Wed Feb 19 21:28:12 2020 +0900
>
>     8
>
>  1 file changed, 20 insertions(+)
>
> commit bdeee6693fc19bcd7cdca2caf399771344796848
> Author: Sebul <[hidden email]>
> Date:   Wed Feb 19 21:25:58 2020 +0900
>
>     webkit
>
>  1 file changed, 47 insertions(+)

This kind of doing commits makes it nearly impossible to follow and
understand the additions you are doing. Everybody needs to have also a
look into the details of your commit to see what you have done. That's
bad because it's costs time on the others side, by this it makes the
work other people do more inefficient.
The current way you doing commit messages makes the usage of the git log
command useless.

Could you please adjust your workflow in the future to make an useful
usage of the topic/subject and if needed of the body of the git commit?
Thanks for consideration!

For example you could use one of the following stanza for the subject
(as other contributors already doing so).

(Korean) DSA-4631-1 pillow
(ko) [DSA 4631-1] pillow security update

--
Regards
Carsten Schoenert
Reply | Threaded
Open this post in threaded view
|

Re: useful topics and commit messages within git commits on webwml repository

Calum McConnell
I don’t think you understand the issue.
See, when you are making changes to the git repository, you at some point need to commit those changes and send them to other people.  Now, you are doing that just fine: but there is one minor issue.

When you commit something, it asks for a message.  Now the message could be anything: however, the way git is meant to be used treats those messages as little titles.  That way, if someone is browsing through the history, they can quickly guess what was done by your commit.  However,  you are apparently entering the message as “commit”.

It’s a bit like titling a file “Essay” or “Document3729”.  Yes, it’s valid;  but if you are looking through later to find, say, that one file where you wrote down how you fixed the WiFi driver last time it died, you won’t have a great day.

What Carsten was asking was if you could enter a more descriptive message.  Even if it was, say, “Korean translation fix” for every change, another developer would be able to guess what it was you changed without having to checkout the commit or know that you are the Korean Translation Coordinator.   That makes their job much easier if they are, for instance,  looking through the history to find the change that broke a feature they use.  If they see “commit”, and no context, they will need to spend a few minutes investigating the commit: and that slows them down.

TL;DR: Entering a description of the change when git prompts you for a message helps your fellow developers out a lot.
Reply | Threaded
Open this post in threaded view
|

Re: useful topics and commit messages within git commits on webwml repository

Archit Warghane
Hello Calum, Team

Do you think if we enforce some sort of tagging with commits might help readability?

For example, I use these tags to all of my projects

[Feature]
[Refactor]
[Fix]
[Chore]
[Tests]

ex: [Refactor | Fix | Chore | Featur | Tests ] Ticket Number - Description

it's not much, but it helps some times... 


Regards,
Archit Warghane


From: Calum McConnell <[hidden email]>
Sent: Sunday, February 23, 2020 10:24 AM
To: sebul <[hidden email]>
Cc: Carsten Schoenert <[hidden email]>; debian-www <[hidden email]>
Subject: Re: useful topics and commit messages within git commits on webwml repository
 
I don’t think you understand the issue.
See, when you are making changes to the git repository, you at some point need to commit those changes and send them to other people.  Now, you are doing that just fine: but there is one minor issue.

When you commit something, it asks for a message.  Now the message could be anything: however, the way git is meant to be used treats those messages as little titles.  That way, if someone is browsing through the history, they can quickly guess what was done by your commit.  However,  you are apparently entering the message as “commit”.

It’s a bit like titling a file “Essay” or “Document3729”.  Yes, it’s valid;  but if you are looking through later to find, say, that one file where you wrote down how you fixed the WiFi driver last time it died, you won’t have a great day.

What Carsten was asking was if you could enter a more descriptive message.  Even if it was, say, “Korean translation fix” for every change, another developer would be able to guess what it was you changed without having to checkout the commit or know that you are the Korean Translation Coordinator.   That makes their job much easier if they are, for instance,  looking through the history to find the change that broke a feature they use.  If they see “commit”, and no context, they will need to spend a few minutes investigating the commit: and that slows them down.

TL;DR: Entering a description of the change when git prompts you for a message helps your fellow developers out a lot.
Reply | Threaded
Open this post in threaded view
|

Re: useful topics and commit messages within git commits on webwml repository

Carsten Schoenert
In reply to this post by sebul
Hello Sebul,

Am 23.02.20 um 04:00 schrieb sebul:
> Is there a problem?
> These are Korean translations.
> I'm Korean tranlation coordinator.
> Who can help Korean translation ?

I think you have missed my point.

It's not about translating into Korean, that's fine and there's nothing
I could fault with.

My criticism is only about how you use the VCS.

In the past 365 days about 104 contributors have provided additions to
the master branch. You are one of these people.

> $ git shortlog -s --branches=master --since="one year ago" | wc -l
> 104

Means that about *103* other contributors have also done git commits in
order to being able to made additions to the git tree. That's not a
small amount of contributors!

Looking at the commit messages you have done and comparing these with
the other commit messages you will see that your commit messages are
mostly just one word (but not all).

Now image someone has to go back only about 180 days because in August
last year some change to the git tree was made that might have
introduced some regression. What probably all people here will do is
starting to investigate by having a view on the commit messages for that
time span.

> $ git log --pretty=format:"%ad - %an: %s" --after="2019-08-01" --until="2019-08-31"

Try to find out what you have done in your commits only by looking at
this output because that's what the investigator needs to do.
Would you agree that the subject other people have used for their commit
is probably more helpful to decide which commit it's worth to get a
closer look?
Would you also agree that subject lines like "Syncing" or simply
"$package" are not a good choice in case you have only the subject line
to decide?

Working on an translation for the webwml repository costs probably more
than 15min-30min with some local testing of your work, writing a
declarative and good git commit message will take about 1min-3min. Is it
really worth to "save" 45 seconds here in the end on your side and make
searching stuff within the git tree for other people more painful?
We are all volunteers and doing work for Debian in our spare time. And
this work needs to make fun, otherwise contributors have no reason to do
such work for free.

Please take about 5min and have a look at the following website and
think about it. This site is now over 5 years old!



Thanks!

--
Regards
Carsten Schoenert

Reply | Threaded
Open this post in threaded view
|

Re: useful topics and commit messages within git commits on webwml repository

Carsten Schoenert
In reply to this post by Archit Warghane
Hello Archit,

Am 23.02.20 um 17:04 schrieb Archit Warghane:

> Hello Calum, Team
>
> Do you think if we enforce some sort of tagging with commits might help readability?
>
> For example, I use these tags to all of my projects
>
> [Feature]
> [Refactor]
> [Fix]
> [Chore]
> [Tests]
>
> ex: [Refactor | Fix | Chore | Featur | Tests ] Ticket Number - Description
>
> it's not much, but it helps some times...

I know such techniques and I'm thinking for while how the work for
contributors of the webwml repository could be improved. The reasoning
to use such tags is quite obvious.

I'm happy if would come to a generic template that contributors are free
to use. To get things further we could start to collect things on a sub
site within the Debian Wiki and discuss this all at a BoF or team meeting.

Git can use templates for commit messages. We could try to use this. We
also could use hooks to check for simple things.

--
Regards
Carsten Schoenert

Reply | Threaded
Open this post in threaded view
|

Re: useful topics and commit messages within git commits on webwml repository

황병희-3
In reply to this post by sebul
sebul <[hidden email]> writes:

> Is there a problem?

Sebul you need to write in detail for commit messages.
(커밋할때 제목을 좀 더 길게 자세하게 적어달라시네요 세벌님^^^)

Sincerely, Byung-Hee from South Korea

--
^고맙습니다 _地平天成_ 감사합니다_^))//

Reply | Threaded
Open this post in threaded view
|

Re: useful topics and commit messages within git commits on webwml repository

황병희-3
In reply to this post by sebul
sebul <[hidden email]> writes:

> Is there a problem?

Sebul you need to write in detail for commit topics.
(커밋할때 제목들을 좀 더 자세히 적어달라고 부탁하시네요 세벌님^^^)

Sincerely, Byung-Hee from South Korea

--
^고맙습니다 _地平天成_ 감사합니다_^))//

Reply | Threaded
Open this post in threaded view
|

Re: useful topics and commit messages within git commits on webwml repository

황병희-3
In reply to this post by sebul
sebul <[hidden email]> writes:

> Is there a problem?

Sebul you need to write in detail for commit topics.
(커밋할때 제목을 좀 더 자세히 적어달라고 부탁하시네요 세벌님^^^)

Sincerely, Byung-Hee

--
^고맙습니다 _地平天成_ 감사합니다_^))//

Reply | Threaded
Open this post in threaded view
|

Re: useful topics and commit messages within git commits on webwml repository

sebul
In reply to this post by 황병희-3
Thank you.

2020년 3월 14일 (토) 오전 2:25, 황병희 <[hidden email]>님이 작성:
sebul <[hidden email]> writes:

> Is there a problem?

Sebul you need to write in detail for commit topics.
(커밋할때 제목들을 좀 더 자세히 적어달라고 부탁하시네요 세벌님^^^)

Sincerely, Byung-Hee from South Korea

--
^고맙습니다 _地平天成_ 감사합니다_^))//



--
足球初盘 太准了 快三长龙有超过12期的吗 金亚洲app注册 大赢家棋牌游戏官网下载 双色球开奖浙江走势图2