kicad/HOW_TO_CONTRIBUTE.txt

Contribute to KiCad (under Linux)
--------------------

1) make sure you have all the dependencies of KiCad:
    sudo apt-get install debhelper dpatch libx11-dev
    sudo apt-get install libglu1-mesa-dev libgl1-mesa-dev mesa-common-dev
    sudo apt-get install libwxbase2.8-dev libwxgtk2.8-dev libboost-dev fakeroot
    sudo apt-get install cmake bzr
    sudo apt-get install cmake bzr bzrtools

2) initialize Bazaar:
    bzr whoami "John Doe <john.doe@gmail.com>"

3) get LATEST KiCad source tree and name it, for instance, "kicad_john":
    cd ~/
    bzr branch lp:kicad kicad_john

4) Read coding_style_policy.pdf, in <kicad_sources>/Documentation,
    and other docs.

5) Modify/add source code.
    cd kicad_john
    gedit .......

6) Compile:
    cd kicad_john
    mkdir build; cd build
    cmake ../ -DKICAD_TESTING_VERSION=ON -DCMAKE_BUILD_TYPE=Debug
    to build a debug version
    or
    cmake ../ -DKICAD_TESTING_VERSION=ON -DCMAKE_BUILD_TYPE=Release
    to build a release version
    make

7) Repeat step 5 and 6 until satisfied.

8) Create a patch:
    in kicad_john:
    if some files are added: bzr add [FILE...]
    bzr diff  > my_changes.patch

9) Send the patch file "my_changes.patch" to the KiCad developers mailing list.
   in the subject of the e-mail include the keyword "[PATCH]".
   in the body of the e-mail clearly explain what you have done.


for more info see INSTALL.txt.