Get the Windows bots closer to green
[WebKit-https.git] / WebKitSite / coding / contributing.html
1 <?php 
2     $title="Contributing Code";
3     include("../header.inc"); 
4 ?>
5 <h2>Contributing Code</h2>
6 <p>Contributing code to the WebKit project is a straightforward process.
7 Once you have the code <a href="/building/checkout.html">checked out</a>, <a href="/building/build.html">built</a>, and made your changes, you'll need to do a few things in order to get it landed in the tree:</p>
8 <ol>
9     <li>Make sure your changes meet the <a href="/coding/coding-style.html">code style guidelines</a>.</li>
10     <li>Run the layout tests using the <tt>run-webkit-tests</tt> script and make sure they all pass.
11         See the <a href="/quality/testwriting.html">testing page</a> for more information, as well as what you need to do if you've modified JavaScriptCore.</li>
12     <li>Add any new files and layout tests to Subversion using the <tt>svn add</tt> command.</li>
13     <li>Prepare a changelog entry. The <tt>prepare-ChangeLog</tt> script will create a stub entry for you.</li>
14     <li>Create the patch using the <tt>svn-create-patch</tt> script.</li>
15     <li>Upload the patch for review. In Bugzilla, be sure to set the <tt>review:?</tt> flag.</li>
16     <li>Make any changes recommended by the reviewer.</li>
17     <li>Once reviewed, get your patch landed in the tree and watch for any regressions it may have caused (hopefully none)!</li>
18 </ol>
19
20
21 <h3>Code Style Guidelines</h3>
22 <p>In order for your patch to be landed, it's necessary that it comply to the <a href="/coding/coding-style.html">code style guidelines</a>.
23 There are some older parts of the codebase that do not always follow these guidelines. If you come across code like this,
24 it's generally best to clean it up to comply with the new guidelines.</p>
25
26 <h3>Regression tests</h3>
27 <p>Once you have made your changes, you need to run the regression tests, which is done via the <tt>run-webkit-tests</tt> script.
28 All tests must pass.  Patches will not be landed in the tree if they break existing layout tests.</p>
29
30 <p>For any feature that affects the layout engine, a new regression test must be constructed. If you provide a patch that fixes a bug,
31 that patch should also include the addition of a regression test that would fail without the patch and succeed with the patch.
32 If no regression test is provided, the reviewer will ask you to revise the patch, so you can save time by constructing the test up
33 front and making sure it's attached to the bug. If no layout test can be (or needs to be) constructed for the fix, you must explain
34 why a new test isn't necessary to the reviewer.</p>
35
36 <p>Information on writing a layout test as well as what needs to be done if you've made changes to JavaScriptCore
37 can be found on the <a href="/quality/testwriting.html">testing page</a>.</p>
38
39 <h3>Adding new files</h3>
40 <p>New files and layout tests must be added to Subversion or else they won't be included in your patch. This is done with the <tt>svn add</tt> command.
41 More information on Subversion commands can be found via <tt>svn help</tt> or the <a href="http://svnbook.red-bean.com/">Version Control with Subversion</a> online book.</p>
42
43 <h3>ChangeLog</h3>
44 <p>All patches require an entry to the ChangeLog. The <tt>prepare-ChangeLog</tt> script will create a basic entry containing a list
45 of all files that have been changed.  Use this to write up a brief summary of the changes you've made.  Don't worry about the
46 "Reviewed by NOBODY (OOPS!)" line, the person landing your patch will fill this in.</p>
47
48 <h3>Create the patch</h3>
49 <p>WebKit uses the <tt>svn-create-patch</tt> script to create patches. This script supplements Subversion's <tt>diff</tt> command
50 to better handle things like moved, added, and deleted files. This command is best run from the top level of your checkout to make
51 sure no changes are left out of your patch. It is not necessary to break a patch into multiple files.</p>
52
53 <p><tt>svn-create-patch</tt> does not create a file automatically, you need to redirect the output yourself using something like: <tt>svn-create-patch > MyExcellentPatch.txt</tt></p>
54
55 <h3>Patch review</h3>
56 <p>Once you have a patch file, it must be reviewed by one of the approved WebKit reviewers. To request a review, attach the patch
57 to the bug report, and mark the patch with the flag <tt>review:?</tt>. The reviewer will typically either approve the patch
58 (by responding with an <tt>r=me</tt> in the bug report or in e-mail and marking the patch <tt>review:+</tt>) or request revisions
59 to the patch (and mark the patch <tt>review:-</tt>). In rare cases a patch may be permanently rejected, meaning that the reviewer
60 believes the feature should never be committed to the tree. The review process can consist of multiple iterations between you and
61 the reviewer as revisions are made to your patch.</p>
62
63 <h3>Landing in the tree</h3>
64 <p>Once a patch is approved, someone with commit access will land your patch. Your responsibility for the patch does not end with
65 the patch landing in the tree. There may be regressions from your change or additional feedback from reviewers after the patch has landed.
66 It is your responsibility to be available should regressions arise and to respond to additional feedback that happens after a check-in.</p>
67
68 <h2>WebKit Scripts</h2>
69 <p><tt>WebKitTools/Scripts</tt> contains a number of scripts to help make life easier when submitting a patch. All scripts mentioned
70 on this page (and on the rest of the site as well) are located here unless otherwise mentioned.</p>
71 <p>It's handy to put this directory in your shell path so you can just type the commands without having to specify the path to
72 the script each time.</p>
73
74 <h2>Obtaining Commit and Review Privileges</h2>
75 <p>Our <a href="commit-review-policy.html">Committer and Reviewer policy</a> provides details on obtaining commit and review privileges.</p>
76
77 <?php
78     include("../footer.inc");
79 ?>