kicad-developers team mailing list archive
-
kicad-developers team
-
Mailing list archive
-
Message #31288
Re: Update of KiCad documentation?
We used to have an ether pad on pads.kicad-pcb.org where I collected notes
on new features and changes for 5.0.0. But this is down, and Ajo who runs
it has been unresponsive for quite some time. I was intending to start a
news post on the website to collect it, but I didn't manage to do this in
time.
2017-11-02 7:56 GMT+01:00 Carsten Schoenert <c.schoenert@xxxxxxxxxxx>:
> Am 01.11.2017 um 16:20 schrieb Marco Ciampa:
>
> > This is my suggestion:
> >
> > Dev programmers whose group of patches were made accepted in the master
> > tree should at least write a line in the (now inexistent) NEWS file.
>
> That's the way it's typically working. And looking at workflows and
> methods of other long term projects can really help to not reinvent
> wheels again.
>
> Git itself can produce some of the entries if commit are made wisely.
>
> git log --online [foo-options]
> git whatchanged
>
> are the things I mostly use to get an overview whats happen in the past.
> And that's why git commits should strictly follow some rules, otherwise
> I need an expensive amount of time to get the needed overview what has
> changed.
>
> > That should be made during or immediately afterwards the git merge.
> > Now tracing the new features of KiCad could be very difficult.
>
> Can be but shouldn't. I guess every developer who has contributed
> specific parts knows best what his work has changed, improved or added.
> So maybe it should be started here, just write down what comes in mind
> to be worth referenced in a Changelog. Based on this there needs to be
> decided what has to be done on the documentation part.
>
> A Etherpad site could be a starting scratch notepad, someone can pick up
> the notes then into a KiCad wiki site on GitHub?
>
> --
> Regards
> Carsten Schoenert
>
> _______________________________________________
> Mailing list: https://launchpad.net/~kicad-developers
> Post to : kicad-developers@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help : https://help.launchpad.net/ListHelp
>
Follow ups
References