libfirm.github.io/NewDevelopers.html at master · libfirm/libfirm.github.io · GitHub

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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
        <head>
                <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no"/>
                <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
                <title>Firm - New Developers</title>
                <link rel="stylesheet" type="text/css" href="style.css"/>
                <link rel="stylesheet" type="text/css" href="pygments.css"/>
                <link rel="icon" type="image/png" href="logo-simple.png"/>
        </head>
        <body>
                <div class="layout-header">
                        <a href="index.html"><img src="logo.png" alt="Firm Logo" /></a>
                </div>
                <div class="layout-content-wrapper">
                        <div class="layout-content">
                                <div class="layout-sidebar">
                                        <ul>
                                                <li><a href="index.html">About</a></li>
                                                <li><a href="Features.html">Features</a></li>
                                                <li><a href="Download.html">Download</a></li>
                                                <li><a href="Documentation.html">Documentation</a></li>
                                                <li><a href="Projects.html">Projects</a></li>
                                                <li><a href="Development.html">Development</a></li>
                                                <li><a href="Contact.html">Contact</a></li>
                                        </ul>
                                        <ul class="external">
                                                <li><a href="http://pp.info.uni-karlsruhe.de/projects/firm_publications.php">Publications</a></li>
                                        </ul>
                                </div>
                                <div class="layout-document">
                                        <h1>New Developers</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p>This site collects good advice to novice firm developers. So if you&#8217;re new to firm and want to contribute please read the following points carefully.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_coding_conventions">Coding Conventions</h2>
<div class="sectionbody">
<div class="paragraph"><p>Please respect the <a href="Coding_Conventions.html">Coding Conventions</a></p></div>
</div>
</div>
<div class="sect1">
<h2 id="_committing">Committing</h2>
<div class="sectionbody">
<div class="paragraph"><p>If you&#8217;re a student your probably have full access to the repository. Nonetheless consider the following points:</p></div>
<div class="ulist"><ul>
<li>
<p>
Don&#8217;t even think about commiting if your code doesn&#8217;t compile
</p>
</li>
<li>
<p>
Grab the testsuite and see if your changes broke any testcases (note that there are usually some testcases broken anyway, but your code mustn&#8217;t increase the number of broken testcases)
</p>
</li>
<li>
<p>
And if this is your first commit (to the firm repository): <strong>Show us your code and let us do a code review before you commit!</strong>
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_debugging">Debugging</h2>
<div class="sectionbody">
<div class="paragraph"><p>Make your life a little easier and use the <a href="Debug_Extension.html">Debug Extension</a>. Make sure you grab the .gdbinit file from that site.</p></div>
</div>
</div>
                                </div>
                                <div class="clear"></div>
                        </div>
                </div>
                <div class="layout-footer">
                        <span><a href="https://lists.ira.uni-karlsruhe.de/mailman/listinfo/firm">Mailing list</a>: <a href="mailto:firm@ipd.info.uni-karlsruhe.de">firm@ipd.info.uni-karlsruhe.de</a></span>
                </div>
        </body>
</html>