← Back to team overview

kicad-developers team mailing list archive

Re: Pointers to start contributing


Agreed! I was literally about to suggest the same thing. Add to this page:

That type of info (from Seth just now) would best be served I think though
on a KiCad wiki, where any developer or contributor with edit access can
just jump in and click an edit button and type that up or make edits or
improvements as they see fit. Would it be possible for KiCad to get a wiki?
The wiki could grow to include a ton of info like this, and would be very
beneficial to everyone. It could even include KiCad tutorials and things,
and wikis can move and be updated much faster than other types of
documentation (think Wikipedia as an example). I have access to a wiki at
work, for instance, which I use all the time to document commands, how-tos,
programming instructions, hardware details, etc. It's super useful. And
since other people have edit privileges too, I tell them if they see a
mistake in my page while they are following my tutorial to just fix it and
be done. It takes out the overhead of going back and forth.

The Wiki service we use at my work is called "Phriction", and it is part of
a bigger suite of developer software called "Phacility."
Phriction wiki info page: https://www.phacility.com/phabricator/phriction/
Pricing page (it's free and open source!):
Installation guide (this guide itself is a Phriction wiki page, so here's
what one looks like!):

What do you all think? Can KiCad make a wiki?


*Check out my Computa Pranksta
device sold on Amazon!*

On Fri, Jun 28, 2019 at 9:51 AM Ben Hest <bombledmonk@xxxxxxxxx> wrote:

> Hey Seth
> Wow, that was a good summary!  I wonder if there's no some way to include
> some form of this as the TL;DR version of the contribute/developers page
> <http://kicad-pcb.org/contribute/developers/> [1] on the website. That
> page is comprehensive but overwhelming.
> Ben
> [1]http://kicad-pcb.org/contribute/developers/
> On Fri, Jun 28, 2019 at 11:07 AM Seth Hillbrand <seth@xxxxxxxxxxxxx>
> wrote:
>> On 2019-06-27 22:01, Pradeepa Senanayake wrote:
>> > Hello,
>> >
>> > I've recently started using KiCAD and I absolutely love it. Since it
>> > is open-source, I though I'll contribute to the project in which ever
>> > way I can.
>> >
>> > I have been using Orcad, Altium and Eagle during my career as an
>> > Electronics Engineer and then I had to work in Software. Therefore,
>> > I'm well versed in C, C++ and Python too.
>> >
>> > I've already built the project referring the documentation. I'm
>> > planning to go through the source code to just understand the
>> > architecture. Is there an architectural document for KiCAD? If there
>> > is anyone who has time to give me any pointers, it would be greatly
>> > appreciated.
>> Hi Pradeepa-
>> Welcome!  We are always happy to have new contributors.  There are some
>> limited architectural details in the source tree under
>> "Documentation/development".  You should feel free to ping the list with
>> any questions.
>> A good way to jump in would be to find a bug and fix it.  We track them
>> at [1].  There are 23 "Starter" bugs that would be good jumping-off
>> points.  These are bugs that developers have judged to be relatively
>> self-contained and straight-forward to implement.  If you'd like to work
>> on a bug, you can claim it by assigning it to yourself and setting the
>> status to "In Progress".  After you have a proposed fix, you can check
>> your kicad-style formatting by using the format checker in
>> tools/check_coding.sh and then output it using `git format-patch HEAD~`.
>>   You attach the patch to the bug report and we'll review it and work
>> with you to get it integrated.  You can also e-mail your patch to the
>> mailing list if you'd like.
>> After a few bugs, you'll start to get a feel for the section of the code
>> you are working in.  You might want to branch out in to the general bug
>> reports that are targeted to our next release [3].  Before claiming new
>> feature items on that list, I'd recommend asking (in the bug report or
>> on the mailing list) whether anyone is working on things in the area.
>> Be aware that the code base is moving fairly rapidly at the moment, so
>> you may need to be rebase your commit a few times before it is
>> integrated.
>> Lastly, Jon Evans gave a great talk at KiCon on how to begin hacking on
>> the codebase[4] and his insights are well worth your time.
>> Good Luck!  And let us know if you need anything-
>> Seth
>> [1] https://bugs.launchpad.net/kicad
>> [2] https://bugs.launchpad.net/kicad/+bugs?field.tag=starter
>> [3] https://launchpad.net/kicad/+milestone/6.0.0-rc1
>> [4] https://www.youtube.com/watch?v=DSWm5H0lVo0
>> _______________________________________________
>> 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
> --
> -Ben
> _______________________________________________
> 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