You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@nlpcraft.apache.org by Aaron Radzinski <ar...@datalingvo.com> on 2021/07/01 20:52:13 UTC
commit messages
NLPCraft-ers,
Thanks for Rahul for pointing out that our implicit practice on using
a default "WIP" commit message is rather not informative and it
pollutes Git history.
I would suggest the community adopts the rule by which we always add a
ticket number (i.e. branch numbers) to the commit message, i.e. "WIP"
=> "WIP on NLPCRAFT-123". This way the Git history becomes much more
descriptive.
Thoughts?
--
Aaron Radzinski
Re: commit messages
Posted by Nikita Ivanov <ni...@gmail.com>.
+1 on Rahul's suggestion.
(as one of the original founders of Apache Ignite & GridGain Systems - I
can attest it took a long time to establish some of the engineering
processes in this community... NLPCraft can certainly borrow from the best.)
--
Nikita Ivanov
On Fri, Jul 2, 2021 at 5:35 PM Rahul Padmanabhan <
rahul.padmanabhan@mail.concordia.ca> wrote:
> Hello,
>
> Aaron, thanks for the email on this. For the sake of context, I was
> looking at the Apache Ignite project git repo and I saw that having
> clickable links to the JIRA ticket on the master branch commits looked very
> organized (they even have the link to the pull request on the commits as
> well). I think if we can start doing this going forward, for the master
> branch, it would cascade into having a more organized project.
>
> -Rahul
>
> On 7/2/21 2:33 PM, Aaron Radzinski wrote:
>
> I guess this works too.
> --
> Aaron Radzinski
>
>
> On Fri, Jul 2, 2021 at 11:16 AM Sergey Kamov <skhdlemail@gmail.com
> ><ma...@gmail.com> wrote:
>
>
>
> Hi.
>
> Do we really need it if we use squash commits ?
> Usually I use WIP comment for intermediate commits in the working branch,
> and on squash commit phase ( to master branch) more detailed message. This
> detailed message can be extended by ticket number i guess.
>
> Regards,
> Sergey
>
> чт, 1 июл. 2021 г., 23:52 Aaron Radzinski <aradzinski@datalingvo.com
> ><ma...@datalingvo.com>:
>
>
>
> NLPCraft-ers,
> Thanks for Rahul for pointing out that our implicit practice on using
> a default "WIP" commit message is rather not informative and it
> pollutes Git history.
>
> I would suggest the community adopts the rule by which we always add a
> ticket number (i.e. branch numbers) to the commit message, i.e. "WIP"
> => "WIP on NLPCRAFT-123". This way the Git history becomes much more
> descriptive.
>
> Thoughts?
> --
> Aaron Radzinski
>
>
>
Re: commit messages
Posted by Rahul Padmanabhan <ra...@mail.concordia.ca>.
Hello,
Aaron, thanks for the email on this. For the sake of context, I was looking at the Apache Ignite project git repo and I saw that having clickable links to the JIRA ticket on the master branch commits looked very organized (they even have the link to the pull request on the commits as well). I think if we can start doing this going forward, for the master branch, it would cascade into having a more organized project.
-Rahul
On 7/2/21 2:33 PM, Aaron Radzinski wrote:
I guess this works too.
--
Aaron Radzinski
On Fri, Jul 2, 2021 at 11:16 AM Sergey Kamov <sk...@gmail.com> wrote:
Hi.
Do we really need it if we use squash commits ?
Usually I use WIP comment for intermediate commits in the working branch,
and on squash commit phase ( to master branch) more detailed message. This
detailed message can be extended by ticket number i guess.
Regards,
Sergey
чт, 1 июл. 2021 г., 23:52 Aaron Radzinski <ar...@datalingvo.com>:
NLPCraft-ers,
Thanks for Rahul for pointing out that our implicit practice on using
a default "WIP" commit message is rather not informative and it
pollutes Git history.
I would suggest the community adopts the rule by which we always add a
ticket number (i.e. branch numbers) to the commit message, i.e. "WIP"
=> "WIP on NLPCRAFT-123". This way the Git history becomes much more
descriptive.
Thoughts?
--
Aaron Radzinski
Re: commit messages
Posted by Aaron Radzinski <ar...@datalingvo.com>.
I guess this works too.
--
Aaron Radzinski
On Fri, Jul 2, 2021 at 11:16 AM Sergey Kamov <sk...@gmail.com> wrote:
>
> Hi.
>
> Do we really need it if we use squash commits ?
> Usually I use WIP comment for intermediate commits in the working branch,
> and on squash commit phase ( to master branch) more detailed message. This
> detailed message can be extended by ticket number i guess.
>
> Regards,
> Sergey
>
> чт, 1 июл. 2021 г., 23:52 Aaron Radzinski <ar...@datalingvo.com>:
>
> > NLPCraft-ers,
> > Thanks for Rahul for pointing out that our implicit practice on using
> > a default "WIP" commit message is rather not informative and it
> > pollutes Git history.
> >
> > I would suggest the community adopts the rule by which we always add a
> > ticket number (i.e. branch numbers) to the commit message, i.e. "WIP"
> > => "WIP on NLPCRAFT-123". This way the Git history becomes much more
> > descriptive.
> >
> > Thoughts?
> > --
> > Aaron Radzinski
> >
Re: commit messages
Posted by Sergey Kamov <sk...@gmail.com>.
Hi.
Do we really need it if we use squash commits ?
Usually I use WIP comment for intermediate commits in the working branch,
and on squash commit phase ( to master branch) more detailed message. This
detailed message can be extended by ticket number i guess.
Regards,
Sergey
чт, 1 июл. 2021 г., 23:52 Aaron Radzinski <ar...@datalingvo.com>:
> NLPCraft-ers,
> Thanks for Rahul for pointing out that our implicit practice on using
> a default "WIP" commit message is rather not informative and it
> pollutes Git history.
>
> I would suggest the community adopts the rule by which we always add a
> ticket number (i.e. branch numbers) to the commit message, i.e. "WIP"
> => "WIP on NLPCRAFT-123". This way the Git history becomes much more
> descriptive.
>
> Thoughts?
> --
> Aaron Radzinski
>