Regenerate developer manual
[privoxy.git] / doc / webserver / developer-manual / git.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "">
3 <html>
4 <head>
5   <title>The Git Repository</title>
6   <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
7   <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
8   <link rel="PREVIOUS" title="Introduction" href="introduction.html">
9   <link rel="NEXT" title="Documentation Guidelines" href="documentation.html">
10   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
11   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
12 </head>
13 <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink="#840084" alink="#0000FF">
14   <div class="NAVHEADER">
15     <table summary="Header navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
16       <tr>
17         <th colspan="3" align="center">Privoxy Developer Manual</th>
18       </tr>
19       <tr>
20         <td width="10%" align="left" valign="bottom"><a href="introduction.html" accesskey="P">Prev</a></td>
21         <td width="80%" align="center" valign="bottom"></td>
22         <td width="10%" align="right" valign="bottom"><a href="documentation.html" accesskey="N">Next</a></td>
23       </tr>
24     </table>
25     <hr align="left" width="100%">
26   </div>
27   <div class="SECT1">
28     <h1 class="SECT1"><a name="GIT" id="GIT">2. The Git Repository</a></h1>
29     <p>If you become part of the active development team, you will eventually need write access to our holy grail, the
30     Git repository. One of the team members will need to set this up for you. Please read this chapter completely
31     before accessing via Git.</p>
32     <div class="SECT2">
33       <h2 class="SECT2"><a name="GITACCESS" id="GITACCESS">2.1. Access to Git</a></h2>
34       <p>The project's Git repository is hosted at the <a href="" target="_top">Privoxy
35       website</a>. For Privoxy team members with push privileges the Git repository URL is <tt class=
36       "LITERAL">ssh://</tt>.</p>
37       <p>Contributors without push privileges can <span class="QUOTE">"git clone
39       <p>The central repository is called <tt class="LITERAL">privoxy</tt>, and the source branch is called <tt class=
40       "LITERAL">master</tt>. Subfolders exist within the project for target-dependent build and packaging tools, each
41       including the name of the target operating system in their name (e.g. Windows, OSXPackageBuilder, debian). There
42       is a webview of the Git hierarchy at <a href=";a=tree" target=
43       "_top">;a=tree</a>, which might help with visualizing how these
44       pieces fit together.</p>
45     </div>
46     <div class="SECT2">
47       <h2 class="SECT2"><a name="GITBRANCHES" id="GITBRANCHES">2.2. Branches</a></h2>
48       <p>Whilst the central repository contains only the master branch, developers are of course free to create
49       branches in their local repositories as they develop features, fixes, or update the target-dependent tools. Only
50       once such changes are fully tested ought they be pushed back to the central repository master branch.</p>
51       <p>At one time there were two distinct branches: stable and unstable. The more drastic changes were to be in the
52       unstable branch. These branches have now been merged to minimize time and effort of maintaining two branches.</p>
53     </div>
54     <div class="SECT2">
55       <h2 class="SECT2"><a name="GITCOMMIT" id="GITCOMMIT">2.3. Git Commit Guidelines</a></h2>
56       <p>The source tree is the heart of every software project. Every effort must be made to ensure that it is
57       readable, compilable and consistent at all times. We expect anyone with Git access to strictly adhere to the
58       following guidelines:</p>
59       <p>Basic Guidelines, for all branches:</p>
60       <ul>
61         <li>
62           <p>Please don't commit even a small change without testing it thoroughly first. When we're close to a public
63           release, ask a fellow developer to review your changes.</p>
64         </li>
65         <li>
66           <p>Your commit message should give a concise overview of <span class="emphasis"><i class="EMPHASIS">what you
67           changed</i></span> (no big details) and <span class="emphasis"><i class="EMPHASIS">why you changed
68           it</i></span> Just check previous messages for good examples.</p>
69         </li>
70         <li>
71           <p>Don't use the same message on multiple files, unless it equally applies to all those files.</p>
72         </li>
73         <li>
74           <p>If your changes span multiple files, and the code won't recompile unless all changes are committed (e.g.
75           when changing the signature of a function), then commit all files one after another, without long delays in
76           between. If necessary, prepare the commit messages in advance.</p>
77         </li>
78         <li>
79           <p>Before changing things on Git, make sure that your changes are in line with the team's general consensus
80           on what should be done.</p>
81         </li>
82         <li>
83           <p>Note that near a major public release, we get more cautious. There is always the possibility to submit a
84           patch to the <a href=";group_id=11118&#38;func=browse"
85           target="_top">patch tracker</a> instead.</p>
86         </li>
87       </ul>
88     </div>
89   </div>
90   <div class="NAVFOOTER">
91     <hr align="left" width="100%">
92     <table summary="Footer navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
93       <tr>
94         <td width="33%" align="left" valign="top"><a href="introduction.html" accesskey="P">Prev</a></td>
95         <td width="34%" align="center" valign="top"><a href="index.html" accesskey="H">Home</a></td>
96         <td width="33%" align="right" valign="top"><a href="documentation.html" accesskey="N">Next</a></td>
97       </tr>
98       <tr>
99         <td width="33%" align="left" valign="top">Introduction</td>
100         <td width="34%" align="center" valign="top">&nbsp;</td>
101         <td width="33%" align="right" valign="top">Documentation Guidelines</td>
102       </tr>
103     </table>
104   </div>
105 </body>
106 </html>