Stamped by Maciej.
[WebKit-https.git] / WebKitSite / coding / contributing.html
1 <?php 
2         $title="Contributing Code";
3         include("../header.inc"); 
4 ?>
5
6 <h2>Contributing Code</h2>
7
8 <h3>Submitting Code Changes</h3>
9
10 <p>Contributing code to the WebKit project is a straightforward process.
11 One you have checked out and built the code, you can make changes to it and then produce a <i>patch file</i>
12 that contains only the differences between the current version of WebKit and your version of WebKit with your code changes.</p>
13
14 <p>The <tt>svn-create-patch</tt> script, found in WebKitTools/Scripts along with the other WebKit scripts, should be used to produce patches.
15 It does a <tt>svn</tt> <tt>diff</tt> operation, passing appropriate options to diff:</p>
16 <p class="code">WebKitTools/Scripts/svn-create-patch > MyExcellentPatch.txt</p>
17 <p>It's handy to put the <tt>WebKitTools/Scripts</tt> directory in your shell path so you can type commands like <tt>svn-create-patch</tt>
18 without specifying the path to the script.</p>
19 <p>The <tt>svn-apply</tt> and <tt>svn-unapply</tt> scripts are handy for applying patches to a tree, and rolling patches out of a tree.
20 They go beyond the capabilities of the <tt>patch</tt> tool by handling files added and removed from the repository.</p>
21
22 <p>Once you have a patch file, it must be reviewed by one of the approved WebKit reviewers.
23 To request a review, attach the patch to the bug report, and mark the patch with the flag <tt>review:?</tt>. This will automatically
24 send mail to <a href="mailto:webkit-reviews@opendarwin.org">webkit-reviews@opendarwin.org</a> on your behalf. The 
25 <a href="../quality/lifecycle.html">WebKit Bug Life Cycle</a> page
26 has more information about the stages of a WebKit Bugzilla bug.</p>
27
28 <p>Make sure that your patch includes a ChangeLog entry, meets the
29 <a href="../coding/coding-style.html">coding style guidelines</a>, and has received sufficient testing.
30 Bug fixes should include a <a href="../quality/testing.html">new WebKit or JavaScriptCore test</a>.</p>
31
32 <p>The reviewer will typically either approve the patch (by responding with an <tt>r=me</tt> in the bug report or in e-mail
33 and marking the patch <tt>review:+</tt>)
34 or request revisions to the patch (and mark the patch <tt>review:-</tt>).
35 In rare cases a patch may be permanently rejected, meaning that the reviewer believes the feature should never be committed to the tree.
36 The review process can consist of multiple iterations between you and the reviewer as revisions are made to your patch.</p>
37
38 <p>For any feature that affects the layout engine, a new regression test must be constructed.
39 If you provide a patch that fixes a bug, that patch should also include the addition of a regression test that
40 would fail without the patch and succeed with the patch.
41 If no regression test is provided, the reviewer will ask you to revise the patch, so you can save time by constructing
42 the test up front and making sure it's attached to the bug.
43 If no layout test can be (or needs to be) constructed for the fix, you must explain why a new test isn't necessary to the reviewer.</p>
44
45 <p>In addition you must run the regression tests. The command to do that is:</p>
46 <p class="code">WebKitTools/Scripts/run-webkit-tests</p>
47 <p>It's handy to put the <tt>WebKitTools/Scripts</tt> directory in your shell path so you can type commands like
48 <tt>run-webkit-tests</tt> without specifying the path to the script.</p>
49 <p>Only if all layout tests pass
50 (or if justification can be made for changing the expected results of the tests) will the patch be allowed in the tree.  It is the reviewer's
51 responsibility to double-check that you have run the regression tests before signing off on the patch.</p>
52
53 <p>If you are modifying JavaScriptCore there is an additional test suite that you need to run.  For more details on the required testing you must
54 do before landing a patch, see our <a href="../quality/testing.html">testing page</a>.
55
56 <p>Once a patch has been reviewed, there are two options for getting it into the tree.
57 If you have check-in privileges, you can land the patch immediately once it has been reviewed.
58 If you do not have check-in privileges, then it is the reviewer's responsibility to land the patch in the tree.</p>
59
60 <p>Your responsibility for the patch does not end with the patch landing in the tree.
61 There may be regressions from your change or additional feedback from reviewers after the patch has landed.
62 It is your responsibility to be available should regressions arise and to respond to additional feedback that happens after a check-in.</p>
63
64 <h3>Obtaining Check-In Privileges</h3>
65
66 <p>Contributors with a proven track record of good patch submissions and that have demonstrated an ability to work well with the community can
67 obtain check-in privileges to the WebKit source tree. In order to obtain this check-in access, the contributor must find a reviewer who
68 will act as a sponsor.</p>
69
70 <p>The sponsor arranges a copy of the committer agreement to be sent to the contributor.
71 Once the contributor sends a copy of the signed agreement to Apple, he receives check-in access.</p>
72
73 <h3>Becoming a Reviewer</h3>
74
75 <p>A contributor with check-in access may also become a reviewer.  In order to become a reviewer, the current reviewers must agree that the
76 contributor is effectively functioning as an expert in a particular area of the code and is qualified to review patches submitted in
77 that area.</p>
78
79 <p>Reviewers are always responsible only for areas of code in which they are knowledgeable.
80 If the reviewer does not feel qualified to handle a particular patch, then he will defer to another reviewer.</p>
81 <?php
82         include("../footer.inc");
83 ?>