summaryrefslogtreecommitdiff
path: root/Documentation/HOW_TO_CONTRIBUTE.txt
blob: d042329528d305193fa5935b9e6d4a52ef9df921 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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:
    cd ~/
    bzr branch lp:kicad kicad.bzr

   this should leave you with the folder kicad.bzr

4) Read coding_style_policy.pdf, in kicad.bzr/Documentation,
   and other docs.

5) create a local (branch) copy of the KiCad project
    bzr branch ./kicad.bzr ./kicad.my_contrib

6) Modify/add source code in
    cd kicad.my_contrib
    gedit .......
   if you need to create and add the file foo.cpp do so and:
    bzr add foo.cpp
   if you need to delete files:
    bzr rm foo.cpp

7) Compile:
    cd kicad.my_contrib
    mkdir build; cd build
    cmake ../ -DCMAKE_BUILD_TYPE=Debug
   to build a debug version
   or
    cmake ../ -DCMAKE_BUILD_TYPE=Release
   to build a release version
    make -j8

8) Repeat step 6 and 7 until satisfied.

9) Create a patch file:
    cd kicad.my_contrib
    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.