Andrey, Some rules are good, some rules are bad :)
If you create such a script so that it relies on having a colon in every message, it will never work, simply because people make mistakes. The only consequence of such a rule would be that we will have to fight it forever trying to enforce it. I'm sure you don't want this. -Val On Fri, Mar 20, 2020 at 2:40 PM Andrey Gura <ag...@apache.org> wrote: > Ivan, Val, > > > But is it really important whether someone puts a colon, a dash, or just > a > > space after the ticket number? > > Absolutely not important. But every time when you want to write script > for processing commit messages in some way you should check what > exactly format committers use. > > I do not want to argue about this. But it always better to follow some > rules then not. > > On Fri, Mar 20, 2020 at 3:01 AM Valentin Kulichenko > <valentin.kuliche...@gmail.com> wrote: > > > > I agree with Ivan. All contribution rules should be reasonable and should > > *add value*. > > > > For example, a requirement to include the ticket number is a great idea > as > > it creates a clear link between a commit and a JIRA ticket. This helps to > > track the history, simplifies searches, etc. > > > > But is it really important whether someone puts a colon, a dash, or just > a > > space after the ticket number? I believe there is no difference > whatsoever, > > and it doesn't make sense to overcomplicate. This will only make it > harder > > for new contributors to join the community. > > > > -Val > > > > On Thu, Mar 19, 2020 at 3:59 PM Ivan Pavlukhin <vololo...@gmail.com> > wrote: > > > > > Andrey, > > > > > > I am working with about 4 projects. And I do not want to bother myself > > > whether colon in a commit message is required or prohibited. And I > > > believe that we should encourage to contribute not only those whose > > > full-time job is contribution to Ignite. So, a contribution process > > > should be as simple as possible. It is simple when it follows common > > > sense and practices, but not some project UNNECESSARY rules. > > > > > > > What could be simpler than exactly one format without any optional > > > things? :) > > > A format that conforms with common sense and practices is much simpler. > > > > > > > I don't understand why examples of other project should be > considered at > > > all. > > > To illustrate that there is a common practice to use colon. Also > > > treating colon optional seems to be a common practice at all. > > > > > > And please answer the question from my previous message: > > > > Is there any any harm from a "colon" in a commit message? > > > > > > In my opinion current state with commit messages prefixes is totally > > > fine and there is no need to change anything. > > > > > > Best regards, > > > Ivan Pavlukhin > > > > > > пт, 20 мар. 2020 г. в 01:40, Andrey Gura <ag...@apache.org>: > > > > > > > > Ivan, > > > > > > > > What could be simpler than exactly one format without any optional > > > things? :) > > > > > > > > I don't understand why examples of other project should be considered > > > > at all. Most of commit messages in Apache Ignite have described > format > > > > without additional symbols. It is absolutely okay to require to > follow > > > > such rules. > > > > > > > > On Fri, Mar 20, 2020 at 1:05 AM Ivan Pavlukhin <vololo...@gmail.com> > > > wrote: > > > > > > > > > > Andrey, > > > > > > > > > > Personally I would consider a proper format (where colon is > optional): > > > > > > > > > > IGNITE-XXXX[:] my message > > > > > > > > > > Is there any any harm from a "colon" in a commit message? While we > are > > > > > working in open source simplification is very important. And I > suggest > > > > > to not bother contributors and committers with unnecessary rules. > Not > > > > > all of us contribute only in Ignite and both formats (with colon > and > > > > > not) are common [1, 2, 3]. > > > > > > > > > > [1] https://github.com/apache/kafka/commits/trunk > > > > > [2] https://github.com/apache/hive/commits/trunk > > > > > [3] https://github.com/openjdk/jdk/commits/master > > > > > > > > > > Best regards, > > > > > Ivan Pavlukhin > > > > > > > > > > чт, 19 мар. 2020 г. в 23:15, Alexey Zinoviev < > zaleslaw....@gmail.com>: > > > > > > > > > > > > Ok, lets keep in mind and remind during PRs to each other > > > > > > > > > > > > чт, 19 мар. 2020 г., 17:32 Andrey Gura <ag...@apache.org>: > > > > > > > > > > > > > Igniters, > > > > > > > > > > > > > > please, notice that right commit message format the following: > > > > > > > > > > > > > > IGNITE-XXXX my message > > > > > > > > > > > > > > There is no colon (:) after XXXX. There is no hyphen (-) > between > > > XXXX > > > > > > > and message. There is only one space. > > > > > > > > > > > > > > How to contribute doc [1] doesn't state this as requirement and > > > just > > > > > > > contains some examples of commit message/PR title. But there > are no > > > > > > > docs that requires colon and/or hyphen. So the best approach > here > > > is > > > > > > > *uniformity*. > > > > > > > > > > > > > > [1] > > > https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute > > > > > > > > > > >
