Looks good to me! Thanks for taking care of this. Cheers,
Wayne On 11/24/2017 11:14 AM, Maciej Sumiński wrote: > To have a concrete text that we can discuss, I propose an update to the > Contribute->Developers page with the attached patch. What do you think? > > Cheers, > Orson > > On 11/22/2017 04:21 PM, Wayne Stambaugh wrote: >> On 11/22/2017 10:16 AM, Maciej Sumiński wrote: >>> On 11/22/2017 03:55 PM, Wayne Stambaugh wrote: >>>> On 11/22/2017 08:55 AM, Maciej Sumiński wrote: >>>>> On 11/22/2017 02:48 PM, Marco Ciampa wrote: >>>>> [snip] >>>>>> Please please please, >>>>>> >>>>>> when some new feature is accepted (code merged in master branch), either >>>>>> write it in the dev (master) branch of the documentation or somewhere to >>>>>> enable doc writers to describe the new feature... (wiki? txt in the >>>>>> source code? Bug Report?) >>>>>> >>>>>> I think that a simple description in a bug report is the easiest way to >>>>>> assure that new features get correctly described in the docs. >>>>>> Parsing dev ml messages for these "hints" is IMHO unmanageable... >>>>>> >>>>>> TIA >>>>>> >>>>> >>>>> Hi Marco, >>>>> >>>>> I thought we are supposed to use tags in commit messages (NEW, CHANGE) >>>>> [1]. I can create a bug report in the documentation repository, if this >>>>> is the preferred way. If so, then I suppose it should be made a policy. >>>> >>>> You are and you did. Nice job! The real question is how does this >>>> information make it from the source repo commit messages to doc devs so >>>> the docs can be updated accordingly? >>> >>> For example: >>> >>> git log --grep="CHANGE[D]\?:\|REMOVE[D]\?:\|NEW:" >>> >>> I can turn it into an alias and add it to the same files that handles >>> 'git fixes' command. You can also extend the query with a date or a >>> commit hash. This way, once you enable the git alias configuration you >>> may type: >>> >>> git changelog --since="1 Jan 2017" >>> >>> or >>> >>> git changelog 527c6f001 >> >> Sorry about the miscommunication . I am aware of how to extract the >> information from git but I meant how does this information get to the >> doc devs? Are we expecting doc devs to periodically check the source >> repo or do we want to do something more sophisticated like sending a >> notice to the doc dev mailing list when a change is committed that >> requires changes to the docs? I'm not saying this is what I want and >> I'm OK with whatever we decide, I'm just asking the question. >> >>> >>>>> >>>>> I am afraid it might be hard to follow for occasional patch submitters, >>>>> should it be the committer responsible for creating a bug report? >>>>> >>>>> Regards, >>>>> Orson >>>>> >>>>> 1. https://git.launchpad.net/kicad/commit/?id=527c6f0014b03 >>>>> >>>>> >>>>> >>>>> _______________________________________________ >>>>> Mailing list: https://launchpad.net/~kicad-developers >>>>> Post to : kicad-developers@lists.launchpad.net >>>>> Unsubscribe : https://launchpad.net/~kicad-developers >>>>> More help : https://help.launchpad.net/ListHelp >>>>> >>>> >>>> _______________________________________________ >>>> Mailing list: https://launchpad.net/~kicad-developers >>>> Post to : kicad-developers@lists.launchpad.net >>>> Unsubscribe : https://launchpad.net/~kicad-developers >>>> More help : https://help.launchpad.net/ListHelp >>>> >>> >>> >>> >>> >>> _______________________________________________ >>> Mailing list: https://launchpad.net/~kicad-developers >>> Post to : kicad-developers@lists.launchpad.net >>> Unsubscribe : https://launchpad.net/~kicad-developers >>> More help : https://help.launchpad.net/ListHelp >>> >> >> _______________________________________________ >> Mailing list: https://launchpad.net/~kicad-developers >> Post to : kicad-developers@lists.launchpad.net >> Unsubscribe : https://launchpad.net/~kicad-developers >> More help : https://help.launchpad.net/ListHelp >> > _______________________________________________ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
