Thread: [limesurvey-translator] SVN Commit messages normalization proposal
The leading Open Source survey tool
Brought to you by:
c_schmitz
From: Thibault Le M. <Thi...@su...> - 2008-11-05 09:37:44
|
Hi all, I'd like to automate the release process. I intend to finalize some scripts of mine which will: * automate the changelog gathering * automate the package building / uploading In order to achieve the first goal, I need the commit messages to have a given syntax so that parsing can be scripted. You'll find my proposals in http://docs.limesurvey.org/tiki-index.php?page=Subversion+Commits+messages Please have a look and try to apply these recommendations when committing to then repository. Of course comments are welcome. Best regards, Thibault |
From: Carsten S. <car...@go...> - 2008-11-05 12:36:20
|
Hi! Looks very good. But what about commits that should not show up in changelog at all and only have dev comments`? Can I leave the first line empty then? Best regards Carsten Thibault Le Meur schrieb: > Hi all, > > I'd like to automate the release process. I intend to finalize some > scripts of mine which will: > * automate the changelog gathering > * automate the package building / uploading > > In order to achieve the first goal, I need the commit messages to have a > given syntax so that parsing can be scripted. > > You'll find my proposals in > http://docs.limesurvey.org/tiki-index.php?page=Subversion+Commits+messages > > Please have a look and try to apply these recommendations when > committing to then repository. > > Of course comments are welcome. > > Best regards, > Thibault > > > ------------------------------------------------------------------------- > This SF.Net email is sponsored by the Moblin Your Move Developer's challenge > Build the coolest Linux based applications with Moblin SDK & win great prizes > Grand prize is a trip for two to an Open Source event anywhere in the world > http://moblin-contest.org/redirect.php?banner_id=100&url=/ > _______________________________________________ > limesurvey-translator mailing list > lim...@li... > https://lists.sourceforge.net/lists/listinfo/limesurvey-translator > -- Best regards from Hamburg/Germany Carsten Schmitz LimeSurvey Project Leader car...@li... http://www.limesurvey.org |
From: Thibault Le M. <Thi...@su...> - 2008-11-05 13:18:52
|
Carsten Schmitz a écrit : > Hi! > > Looks very good. > But what about commits that should not show up in changelog at all and > only have dev comments`? Ideally all commits should be part of a general development goal, even for LS2: for instance "Implement basic question types in LS2". However I agree that at the beginning all commits to the LS2 branch would look like "Implement LS2 core" and thus this will not be really interresting. > Can I leave the first line empty then? That's a possibility or I can propose a new Keyword "Devel". All commit messages beginning with this keyword would be excluded from theautomatically generated changelog. What do you think ? Thibault > > Best regards > > Carsten > > Thibault Le Meur schrieb: >> Hi all, >> >> I'd like to automate the release process. I intend to finalize some >> scripts of mine which will: >> * automate the changelog gathering >> * automate the package building / uploading >> >> In order to achieve the first goal, I need the commit messages to >> have a given syntax so that parsing can be scripted. >> >> You'll find my proposals in >> http://docs.limesurvey.org/tiki-index.php?page=Subversion+Commits+messages >> >> >> Please have a look and try to apply these recommendations when >> committing to then repository. >> >> Of course comments are welcome. >> >> Best regards, >> Thibault >> >> >> ------------------------------------------------------------------------- >> >> This SF.Net email is sponsored by the Moblin Your Move Developer's >> challenge >> Build the coolest Linux based applications with Moblin SDK & win >> great prizes >> Grand prize is a trip for two to an Open Source event anywhere in the >> world >> http://moblin-contest.org/redirect.php?banner_id=100&url=/ >> _______________________________________________ >> limesurvey-translator mailing list >> lim...@li... >> https://lists.sourceforge.net/lists/listinfo/limesurvey-translator >> > > |
From: Carsten S. <car...@go...> - 2008-11-05 13:32:47
|
Hi! Sounds good. I would prefer "Dev" :-). Beside that I would also prefer nouns as keywords: 'Fixed' instead of 'Fix' etc. At least it should be possible as alternative. Thibault Le Meur schrieb: > Carsten Schmitz a écrit : >> Hi! >> >> Looks very good. >> But what about commits that should not show up in changelog at all >> and only have dev comments`? > Ideally all commits should be part of a general development goal, even > for LS2: for instance "Implement basic question types in LS2". > However I agree that at the beginning all commits to the LS2 branch > would look like "Implement LS2 core" and thus this will not be really > interresting. > >> Can I leave the first line empty then? > That's a possibility or I can propose a new Keyword "Devel". All > commit messages beginning with this keyword would be excluded from > theautomatically generated changelog. > What do you think ? > > Thibault > >> >> Best regards >> >> Carsten >> >> Thibault Le Meur schrieb: >>> Hi all, >>> >>> I'd like to automate the release process. I intend to finalize some >>> scripts of mine which will: >>> * automate the changelog gathering >>> * automate the package building / uploading >>> >>> In order to achieve the first goal, I need the commit messages to >>> have a given syntax so that parsing can be scripted. >>> >>> You'll find my proposals in >>> http://docs.limesurvey.org/tiki-index.php?page=Subversion+Commits+messages >>> >>> >>> Please have a look and try to apply these recommendations when >>> committing to then repository. >>> >>> Of course comments are welcome. >>> >>> Best regards, >>> Thibault >>> >>> >>> ------------------------------------------------------------------------- >>> >>> This SF.Net email is sponsored by the Moblin Your Move Developer's >>> challenge >>> Build the coolest Linux based applications with Moblin SDK & win >>> great prizes >>> Grand prize is a trip for two to an Open Source event anywhere in >>> the world >>> http://moblin-contest.org/redirect.php?banner_id=100&url=/ >>> _______________________________________________ >>> limesurvey-translator mailing list >>> lim...@li... >>> https://lists.sourceforge.net/lists/listinfo/limesurvey-translator >>> >> >> > -- Best regards from Hamburg/Germany Carsten Schmitz LimeSurvey Project Leader car...@li... http://www.limesurvey.org |
From: Thibault Le M. <Thi...@su...> - 2008-11-05 14:02:43
|
Carsten Schmitz a écrit : > Hi! > > Sounds good. I would prefer "Dev" :-). Ok,... the shorter, the best > > Beside that I would also prefer nouns as keywords: > 'Fixed' instead of 'Fix' Yep, I agree... I was just waiting to see if someone would ask for it ;-) > etc. > > At least it should be possible as alternative. I'll use a _case_insensitive_ match on the following keywords: * "Update","Updated", * "Update-Language","Updated-Language", * "Fix","Fixed", * "New Feature", * "New-Language" * "Dev" I've added a minus sign to Update-Language, Updated-Language and New-Language as I need a way top differentiate new/updated features from new/updated language commits. New comments ? Thibault |
From: Thibault Le M. <Thi...@su...> - 2008-11-05 14:13:25
|
Another problem with my proposal: See the following commit message: ------ updated do_array_flexible() & do_array_flexiblecolumns() to include <col>s <thead> and <th>s for the header row and remove visual formatting markup. updated do_array_5point() , do_array_10point() , do_array_yesnouncertain() & do_array_increasesamedecrease() to specify column widths. updated CSS for all templates to implement minor changes for do_array_flexiblecolumns() and to vertical-align: bottom all <thead><th> tags. ------ This commit contains multiple patches, thus the commit message includes several lines with "updated" keywords. Currently my proposal fails to handle this as the summary is only parsed on the first line. If we want to accept such commit messages, I need to: * parse all lines from the commit (the NEWLINE char would no more be a comment separator) * consider all lines beginning with a special keyword (can be Dev or Comment) to be excluded from the automatic parsing. What do you think ? Thibault |
From: Carsten S. <car...@go...> - 2008-11-05 14:15:09
|
hi! No minus signs please. We don't need to treat language updates as a different thing, do we? It does not really matter if we write Updated statistics to be better or Updated Kisuaheli language Regards Carsten Thibault Le Meur schrieb: > Carsten Schmitz a écrit : >> Hi! >> >> Sounds good. I would prefer "Dev" :-). > Ok,... the shorter, the best >> >> Beside that I would also prefer nouns as keywords: >> 'Fixed' instead of 'Fix' > Yep, I agree... I was just waiting to see if someone would ask for it ;-) > >> etc. >> >> At least it should be possible as alternative. > I'll use a _case_insensitive_ match on the following keywords: > * "Update","Updated", > * "Update-Language","Updated-Language", > * "Fix","Fixed", > * "New Feature", > * "New-Language" > * "Dev" > > I've added a minus sign to Update-Language, Updated-Language and > New-Language as I need a way top differentiate new/updated features > from new/updated language commits. > > New comments ? > > Thibault -- Best regards from Hamburg/Germany Carsten Schmitz LimeSurvey Project Leader car...@li... http://www.limesurvey.org |
From: Thibault Le M. <Thi...@su...> - 2008-11-05 14:24:20
|
Carsten Schmitz a écrit : > hi! > > No minus signs please. I agree minus sign is not good. > We don't need to treat language updates as a different thing, do we? > It does not really matter if we write > > Updated statistics to be better > or > Updated Kisuaheli language I think it would be better to be able to sort the Language specific changes from the Code changes. This way the changelog would be easier to read. Otherwise we could get mixed changes, like: Updated dataentry Updated french language Updated statistics to be better Updated Kisuaheli language If we enforce the "Updated Language xxx" keyword, I'll be able to sort all language updates: Updated dataentry Updated statistics to be better Updated Language: Kisuaheli Updated Language: french I just need to be able to differentiate "Updated xxx" from "Updated Language xxx". Thibault > > Regards > > Carsten > > Thibault Le Meur schrieb: >> Carsten Schmitz a écrit : >>> Hi! >>> >>> Sounds good. I would prefer "Dev" :-). >> Ok,... the shorter, the best >>> >>> Beside that I would also prefer nouns as keywords: >>> 'Fixed' instead of 'Fix' >> Yep, I agree... I was just waiting to see if someone would ask for it >> ;-) >> >>> etc. >>> >>> At least it should be possible as alternative. >> I'll use a _case_insensitive_ match on the following keywords: >> * "Update","Updated", >> * "Update-Language","Updated-Language", >> * "Fix","Fixed", >> * "New Feature", >> * "New-Language" >> * "Dev" >> >> I've added a minus sign to Update-Language, Updated-Language and >> New-Language as I need a way top differentiate new/updated features >> from new/updated language commits. >> >> New comments ? >> >> Thibault > > |