[Freeswitch-users] Commit message usefullness

[Nathan Neulinger]

I wonder if something like this would address much of his concern:

-------------------
Addition to post commit hook:
generate a branch-specific text file/web page/whatever sequentially listing each commit and message
If the commit references a jira issue, include the 'description' field.
Interspersed in that file would be section headers/highlights for any revision that directly corresponded to a full 
release as tagged by 'git tag'.
-------------------

It's not going to help for a plain 'git log' - that's a fundamental limitation of git unless you make it extra work for 
devs on every commit - but would at least provide a readily accessible "low level changelog" that would show all of the 
changes along with more detail of the change than just the jira issue number.

At the same time, we don't do a release notes field in Jira - if that were enabled, and if if any release notes were 
provided in Jira issues - could highlight those in the same place as the expanded issue description.


-- Nathan


On 09/15/2013 03:46 PM, Cal Leeming [Simplicity Media Ltd] wrote:
> Florian,
>
> The FS core devs are always open to feedback/ideas, especially those which would help others to get involved and
> contribute more.
>
> Several discussions have come up on ways we can improve the workflow to make community contributions easier, but these
> things happen slowly due to the lack of time/resources.
>
> However if you expect to be taken seriously, then a hit-and-run post is probably not the best way to approach things.
>
> Here is my advice - contribute a few hours of your own time putting together a plan on how you think the development
> process could be improved, with examples and solid reasoning. Show us how you think things should be done, what benefit
> it would have to the core devs and the community, and how it could be realistically implemented. Give us examples of how
> specific situations could have been handled better, and what benefits would have been gained.
>
> If you are genuinely sincere in wanting to help solve problems around you, giving something to the community will speak
> a lot louder than a 5 minute email.
>
> Hope this helps
>
> Cal
>
>
> On Sun, Sep 15, 2013 at 5:45 PM, Florian Lohoff <f at zz.de <mailto:f at zz.de>> wrote:
>
>
>     Hola,
>
>     On Fri, Sep 13, 2013 at 04:13:52PM -0500, Anthony Minessale wrote:
>      > Maybe if you didn't phrase it like a complaint it would be more meaningful
>      > but it reads as though you are mad that you had to do work to debug your
>      > issue in our software for your paying customer.  I find the message
>      > offensive and had to resist less polite responses that came to mind.
>
>     Commit messages containing bug ids are nice to track which commit closes
>     a bug - but are not helpful in finding changed behaviour.
>
>     And looking at every individual diff or every individual ticket is
>     impossible without deep understanding of the full inner workings. So it
>     might be possible for you - its impossible for the rest of us. Thats the
>     point i am trying to make - For ME the changelog entrys are useless and
>     i made a point why.
>
>     I dont care if you as the developers change - discuss - or think about
>     it. We are not using freeswitch - we are just technicians trying to
>     solve problems around us.
>
>     The development style of freeswitch makes it hard to follow changes and
>     debug behaviour.
>
>     In our internal git trees we have a bug id/ticket number + short
>     explanation in the shortlog and sometimes full email conversations in
>     commit messages for reference purposes. So when we change ticket systems
>     we dont devaluate our commit logs.
>
>     Flo
>     PS: It wasnt a paying customer - just a helpless one with error logs
>     contain 500 responses to SIP re REGISTERs of his CPEs we as an ISP
>     connect to the network - so before ranting its not our business i was
>     trying to answer with helpful content.
>     --
>     Florian Lohoff f at zz.de <mailto:f at zz.de>
>
>     -----BEGIN PGP SIGNATURE-----
>     Version: GnuPG v1.4.10 (GNU/Linux)
>
>     iQIVAwUBUjXkRpDdQSDLCfIvAQiYIQ//X+UbDKxrmYvVzGRfN1kDkdhZEZl5Ht0/
>     8grSHDQbP8db9OoElrWVmjcMsfWPcPdi7Re5jOTnbAIgUWtHHMP01j+DWYJ23Az5
>     vIt8OUm3FC+RlvXSVSLkn2Xd+OvYtTd3JI8j0jU8c/jrs3kGaV7EI4KODP7l3Cyj
>     7XlnOP93Sxs19wsG1VESpi48Bx4BQoCCOVzmjuI+aWecM2DPQw8ISVOyv6yeh+bn
>     7mr7XfgPFeC9PTjCw7g+j6yloAY045piy7bcPB98czBDC5MScXnIdXzrbGb2RC7C
>     jektbr9Q3dQ7VaR4Hl9dPMsjpCSsQy3YRkHYiq36R6yaz6I87c6dP3nTax3WbSj0
>     LZobNNME1NwxHn/SxiG9cusecZjXTin6o3k+lOLGscv5AfwrAhYU6fnI5l+Z7yy6
>     qh1K0MKKVl2wERJ6B7hk61vBkXC2T5N2qF1XmlfQV7zHo1NTbV4WLYQSE09jytRo
>     kI408xvtIy/cdVsNifs6VFC0tY6Z0pbYrMycR5HVPoBxnq7ExkosHbvkbx7kOlWI
>     n9leyvicQ7KExt1Rtgr4FfrZvewj6/nhkzR5h57+2TPhBe1a7TESkEROalVzpdYV
>     PZaJE0OGK9kXeqXCAA81f4Q1/L9TeJVlYUtQnbB7lxx4XN0fOQJqjSciLnelOnmp
>     pjpCCiFGlbo=
>     =4r4c
>     -----END PGP SIGNATURE-----
>
>     _________________________________________________________________________
>     Professional FreeSWITCH Consulting Services:
>     consulting at freeswitch.org <mailto:consulting at freeswitch.org>
>     http://www.freeswitchsolutions.com
>
>     
>     
>
>     Official FreeSWITCH Sites
>     http://www.freeswitch.org
>     http://wiki.freeswitch.org
>     http://www.cluecon.com
>
>     FreeSWITCH-users mailing list
>     FreeSWITCH-users at lists.freeswitch.org <mailto:FreeSWITCH-users at lists.freeswitch.org>
>     http://lists.freeswitch.org/mailman/listinfo/freeswitch-users
>     UNSUBSCRIBE:http://lists.freeswitch.org/mailman/options/freeswitch-users
>     http://www.freeswitch.org
>
>

-- 
------------------------------------------------------------
Nathan Neulinger                       nneul at mst.edu
Missouri S&T Information Technology    (573) 612-1412
System Administrator - Architect