]> projects.mako.cc - fspm_howto/blobdiff - FreeSoftwareProjectManagementHOWTO.sgml
Finished section 3 on interacting with developers.. just one more
[fspm_howto] / FreeSoftwareProjectManagementHOWTO.sgml
index 4499e578b318aaa0b0c4ae8cdcbfa384c6c848b9..ad8e78fca92668f97ad78843d822a183b00189c9 100644 (file)
    </para>
 
    <para>
    </para>
 
    <para>
-    The latest version number of this document should always be listed 
-    at my webpage at<ulink url="http://people.debian.org/~mako/">
-    http://people.debian.org/~mako/</ulink> Debian.
+    The latest version number of this document should always be listed
+    on <ulink url="http://people.debian.org/~mako/">my webpage at
+    Debian</ulink>.
    </para>
 
    <para>
    </para>
 
    <para>
     development process that it heralds and I think its ultimate
     success will be rooted in this fact. Please send your additions,
     comments and criticisms to the following email address :
     development process that it heralds and I think its ultimate
     success will be rooted in this fact. Please send your additions,
     comments and criticisms to the following email address :
-    <email>mako (at) debian (dot) org</email>.
+    <email>mako@debian. org</email>.
    </para>
    </sect2>
 
    </para>
    </sect2>
 
     available. If you would like to help with or do a translation, you
     will gain my utmost respect and admiration and you'll get to be
     part of a cool process. If you are at all interested, please don't
     available. If you would like to help with or do a translation, you
     will gain my utmost respect and admiration and you'll get to be
     part of a cool process. If you are at all interested, please don't
-    hesitate to contact me at: <email>mako (at) debian (dot)
-    org</email>.
+    hesitate to contact me at: <email>mako@debian.org</email>.
    </para>
    </sect2>
  </sect1>
    </para>
    </sect2>
  </sect1>
    </para>
 
    <sect3 id=identifyidea>
    </para>
 
    <sect3 id=identifyidea>
-    <title>Indentify and Articulate Your Idea</title>
+    <title>Indentify and articulate your idea</title>
     <para>
      Eric S. Raymond writes about how free software projects start in
      his paper, "The Cathedral and the Bazaar" which comes as required
     <para>
      Eric S. Raymond writes about how free software projects start in
      his paper, "The Cathedral and the Bazaar" which comes as required
    </sect3>
 
    <sect3 id=evalulateidea>
    </sect3>
 
    <sect3 id=evalulateidea>
-    <title>Evaluate Your Idea</title>
+    <title>Evaluate your idea</title>
 
     <para>
      In evaluating your idea, you need to ask yourself questions.
 
     <para>
      In evaluating your idea, you need to ask yourself questions.
      <para>
      <variablelist>
        <varlistentry>
      <para>
      <variablelist>
        <varlistentry>
-        <term>freshmeat.net</term>
+        <term>freshmeat.net:</term>
         <listitem>
         <para><ulink url="http://freshmeat.net">freshmeat</ulink>
         describes itself as, <quote>the Web's largest index of Linux
         <listitem>
         <para><ulink url="http://freshmeat.net">freshmeat</ulink>
         describes itself as, <quote>the Web's largest index of Linux
        </varlistentry>
 
        <varlistentry>
        </varlistentry>
 
        <varlistentry>
-        <term>Slashdot</term>
+        <term>Slashdot:</term>
         <listitem>
         <para><ulink url="http://slashdot.org">Slashdot</ulink>
         provides <quote>News for Nerds: Stuff that Matters,</quote>
         <listitem>
         <para><ulink url="http://slashdot.org">Slashdot</ulink>
         provides <quote>News for Nerds: Stuff that Matters,</quote>
        </varlistentry>
 
        <varlistentry>
        </varlistentry>
 
        <varlistentry>
-        <term>SourceForge</term>
+        <term>SourceForge:</term>
         <listitem>
         <para><ulink url="http://sourceforge.net">SourceForge</ulink>
         houses and facilitates a growning number of open source and
         <listitem>
         <para><ulink url="http://sourceforge.net">SourceForge</ulink>
         houses and facilitates a growning number of open source and
        </varlistentry>
 
        <varlistentry>
        </varlistentry>
 
        <varlistentry>
-        <term>Google and Google's Linux Search</term>
+        <term>Google and Google's Linux Search:</term>
         <listitem>
         <para><ulink url="http://www.google.com">Google</ulink> and
         <ulink url="http://www.google.com/linux"> Google's Linux
         <listitem>
         <para><ulink url="http://www.google.com">Google</ulink> and
         <ulink url="http://www.google.com/linux"> Google's Linux
    </para>
    
    <sect3 id="chooselicense">
    </para>
    
    <sect3 id="chooselicense">
-    <title>Choosing a License</title>
+    <title>Choosing a license</title>
 
     <para>
      Any discussion of licenses is also sure to generate at least a
 
     <para>
      Any discussion of licenses is also sure to generate at least a
    </sect3>
 
    <sect3 id="licensechoose">
    </sect3>
 
    <sect3 id="licensechoose">
-    <title>The Mechanics of Licensing</title>
+    <title>The mechanics of licensing</title>
 
     <para>
      The text of the <acronym>GPL</acronym> offers <ulink
 
     <para>
      The text of the <acronym>GPL</acronym> offers <ulink
@@ -749,7 +748,7 @@ for details.
    </sect3>
 
    <sect3 id="licensewarning">
    </sect3>
 
    <sect3 id="licensewarning">
-    <title>Final License Warning</title>
+    <title>Final license warning</title>
 
     <para>
      Please, please, please, place your software under some
 
     <para>
      Please, please, please, place your software under some
@@ -809,18 +808,18 @@ for details.
      </para>
 
       <para>
      </para>
 
       <para>
-       Whether you plan on having a split development model<xref
-       linkend="branches"> or only one version released at a time, my
-       experience with several free software projects and with the
-       Debian project has taught me taht use of Linux's version
-       numbering system is worth taking into consideration. In Debian,
-       all minor versions are stable distributions (2.0, 2.1,
-       etc). However, many people assume that 2.1 is an unstable or
-       development version and continue to use an older version until
-       they get so frusterated with the lack of development and
-       progress that they complain. If you never release an odd minor
-       version but only release even ones, nobody is hurt, and less
-       people are confused.
+       Whether you plan on having a split development model (as
+       described in <xref linkend="branches">) or only one version
+       released at a time, my experience with several free software
+       projects and with the Debian project has taught me taht use of
+       Linux's version numbering system is worth taking into
+       consideration. In Debian, all minor versions are stable
+       distributions (2.0, 2.1, etc). However, many people assume that
+       2.1 is an unstable or development version and continue to use
+       an older version until they get so frusterated with the lack of
+       development and progress that they complain. If you never
+       release an odd minor version but only release even ones, nobody
+       is hurt, and less people are confused.
       </para>
 
      </listitem>
       </para>
 
      </listitem>
@@ -879,16 +878,337 @@ for details.
 
   <sect2 id="documentation">
    <title>Documentation</title>
 
   <sect2 id="documentation">
    <title>Documentation</title>
-   <para></para>
+
+   <para>
+    A huge number of otherwise fantastic free software applications
+    have withered because their author was the only person who knew
+    how to use them well. Even if your program is written primarily
+    for a techno-savvy group of users, documentation is helpful and
+    necessary for the survival of your project. You will learn later
+    in <xref linkend="releasing"> that you must always release
+    something that is usable. <emphasis>A piece of software without
+    documentation is not usuable.</emphasis>
+   </para>
+
+   <para>
+    There are lots of ways to document your project and lots of
+    different people to document for. The idea of documentation the
+    code itself to help facilitate development by a large community is
+    vital but is outside the scope of this HOWTO. This being the case,
+    this section deals mostly useful tactics for user-directed
+    documentation.
+   </para>
+
+   <para>
+    A combination of tradition and necessity has resulted in a
+    semi-regular system method of documentation in most free software
+    projects that is worth following. Both users and developers expect
+    to be able to get documentation in several ways and its essential
+    that you provide the information they are seeking in a form they
+    can read if your project is ever going to get off the
+    ground. People have come to expect:
+   </para>
+
+   <sect3>
+    <title>Man pages</title> 
+
+    <para>Your users will want to be able to type <quote>man
+    foo</quote> end up with a nicely formatted man page highlighting
+    the basic use of their application. Make sure that before you
+    release your program, you've planned for this.
+    </para>
+
+    <para>
+     Man pages are not difficult to write. There is excellent
+     documentation on the man page process available through the
+     <quote>The Linux Man-Page-HOWTO</quote> available through the
+     Linux Documentation project <acronym>(LDP)</acronym> written by
+     Jens Schweikhardt. It is available <ulink
+     url="http://www.schweikhardt.net/man_page_howto.html">from
+     Schweikhardt's site</ulink> or <ulink
+     url="http://www.linuxdoc.org/HOWTO/mini/Man-Page.html">from the
+     <acronym>LDP</acronym></ulink>.
+    </para>
+
+    <para>
+     It is also possible to write man pages using DocBook SGML and
+     convert them into man pages. Because manpages are so simple, I
+     have not been able to follow this up but would love help from
+     anyone who can give me more information on how exactly this is
+     done.
+    </para>
+   </sect3>
+
+   <sect3>
+    <title>Command line accessable documentation</title>
+
+    <para>
+     Most users will expect the most basic amount of documentation to
+     be easily availabe from the command line. For few programs should
+     then documentation extend for more than one screen (24 or 25
+     lines) but it should cover the basic usage, a brief (one or two
+     sentance) description of the program, a list of commands, all the
+     major options, and a pointer to more in-depth documentation for
+     those who need it. The command line documentation for Debian's
+     apt-get serves as an excellent example and a useful model:
+    </para>
+
+    <screen>
+apt 0.3.19 for i386 compiled on May 12 2000  21:17:27
+Usage: apt-get [options] command
+       apt-get [options] install pkg1 [pkg2 ...]
+
+apt-get is a simple command line interface for downloading and
+installing packages. The most frequently used commands are update
+and install.
+
+Commands:
+   update - Retrieve new lists of packages
+   upgrade - Perform an upgrade
+   install - Install new packages (pkg is libc6 not libc6.deb)
+   remove - Remove packages
+   source - Download source archives
+   dist-upgrade - Distribution upgrade, see apt-get(8)
+   dselect-upgrade - Follow dselect selections
+   clean - Erase downloaded archive files
+   autoclean - Erase old downloaded archive files
+   check - Verify that there are no broken dependencies
+
+Options:
+  -h  This help text.
+  -q  Loggable output - no progress indicator
+  -qq No output except for errors
+  -d  Download only - do NOT install or unpack archives
+  -s  No-act. Perform ordering simulation
+  -y  Assume Yes to all queries and do not prompt
+  -f  Attempt to continue if the integrity check fails
+  -m  Attempt to continue if archives are unlocatable
+  -u  Show a list of upgraded packages as well
+  -b  Build the source package after fetching it
+  -c=? Read this configuration file
+  -o=? Set an arbitary configuration option, eg -o dir::cache=/tmp
+See the apt-get(8), sources.list(5) and apt.conf(5) manual
+pages for more information and options.
+    </screen>
+
+    <para>
+     It has become a GNU convention to make this information
+     accessable with the <quote>-h</quote> and the
+     <quote>--help</quote> options. Most GNU/Linux users will expect
+     to be able to retrieve basic documentation these ways so if you
+     choose to use different method, be prepared for the flames and
+     for the fallout that may result.
+    </para>
+   </sect3>
+   <sect3>
+    <title>Files users will expect</title>
+    <para>
+     In addition to man pages and online help, there are certain files
+     where people will look to documentation, especially in any
+     package containing source code. In a source distribution, most of
+     these files can be stored in a the root directery of the source
+     distribution or in a subdirectory of the root called
+     <quote>doc</quote> or <quote>Documentation</quote>. These files include:
+    </para>
+    <para>
+     <variablelist>
+      <varlistentry>
+       <term>README or Readme</term>
+
+       <listitem>
+       <para>
+         A document containing all the basic installation,
+         compiliation, and even basic use instructions that make up
+         the bare minimum information needed to get the program up and
+         running. A README is not your chance to be verbose but needs
+         to be concise and effective. An ideal README is at least 30
+         lines long and more no more than 250.
+        </para>
+       </listitem>
+
+      </varlistentry>
+      <varlistentry>
+       <term>INSTALL or Install</term>
+
+       <listitem>
+       <para>
+         The INSTALL file should be much shorter than the INSTALL file
+         and should quicly and concisely describe how to build and
+         install the program. Usually an install simply instructs the
+         user to run ./configure; make; make install and touches on
+         any unusual options that may be necessary. More advanced
+         users can usually avoid them but it's good practice to at
+         least glance at the file to understand what can be
+         expected. For most relatively standard install procedures and
+         for most programs, INSTALL files are as short as possible are
+         rarely over 100 lines.
+        </para>
+       </listitem>
+
+      </varlistentry>
+      <varlistentry>
+       <term>Changelog, ChangeLog, CHANGELOG, or changelog</term>
+
+       <listitem>
+       <para>
+         A changelog is a simple file that every well-managed free
+         software project should include. A changelog is simple the
+         file that, as its name would imply, logs or documents the
+         changes to a program. The most simple way to do a changelog
+         is to simply keep a file with teh source code for your
+         program and add a section to the top of the changelog with
+         each release describing what has been, changed, fixed, or
+         added to the program. It's a good idea to post the changelog
+         onto the website as well because it can help people decide
+         whether they want or need to upgrade to a newer version or
+         wait for a more signifigant upgrade.
+        </para>
+       </listitem>
+
+      </varlistentry>
+      <varlistentry>
+       <term><acronym>FAQ</acronym></term>
+
+       <listitem>
+       <para>
+         For those of you that don't already
+         know. <acronym>FAQ</acronym> stands for Frequently Asked
+         Questions and the file is a collection of exactly that. FAQs
+         are not difficult to make. Simply make a policy that if you
+         are asked a question or see a question on a mailing list two
+         or more times, add it the question (and its answer) to your
+         FAQs. FAQs are more optional than the files listed above but
+         they can save your time, increase useability, and decrease
+         headaches on all sides.
+        </para>
+       </listitem>
+
+      </varlistentry>
+     </variablelist>
+    </para>
+   </sect3>
+
+   <sect3>
+    <title>Website</title>
+    <para>
+     It's only a sort of an issue of documentation but a good website
+     is quickly becoming an essential part of any free software
+     project. Your website should provide access to documentation (in
+     <acronym>HTML</acronym> if possible). It should also include a
+     section for news and events around your program and a section
+     that details the process of getting involved with development or
+     testing and creates an open invitation. It should also supply
+     links to any mailing lists, similar websites, and directly to all
+     the available ways of downloading your software.
+    </para>
+   </sect3>
+
+   <sect3>
+    <title>Other documentation hints</title>
+
+    <para>
+     It doesn't hurt to distribute any documentation for your program
+     from your website or anywhere else (FAQs etc) with the
+     program. Make a FAQ by cutting and posting common questions and
+     answers from a mailing list or your own email. Then, don't
+     hesitate through this in the programs tarball. If people don't
+     need it, they will delete it. I can repeat it over and over:
+     <emphasis>Too much documentation is not a sin.</emphasis>
+    </para>
+
+    <para>
+     All your documentation should be in plaintext, or, in cases where
+     it is on your website primarily, in HTML. Everyone can cat a
+     file, everyone has a pager, (almost) everyone can render
+     HTML. <emphasis>You are welcome to distribute information in PDF,
+     PostScript, RTF, or any number of other widely used formats but
+     this information must also be available in plaintext or HTML or
+     people will be very angry at you.</emphasis>
+    </para>
+   </sect3>
   </sect2>
 
 <!-- Section2: presentation -->
 
   <sect2 id="presentation">
    <title>Other Presentation Issues</title>
   </sect2>
 
 <!-- Section2: presentation -->
 
   <sect2 id="presentation">
    <title>Other Presentation Issues</title>
-   <para></para>
-  </sect2>
+   <para>
+    Many of the remaining issues surrounding the creation of a new
+    free software program fall under what most people describe as
+    common sense actions. Still, they are worth noting briefly in
+    hopes that they may remind a developer of something they may have
+    forgotten.
+   </para>
+
+   <sect3>
+    <title>Package formats</title>
+    <para>
+     Package formats may differ depending on the system you are
+     developing for. For windows based software, Zip archives (.zip)
+     usually serve as the package format of choice. If you are
+     developing for GNU/Linux, *BSD, or any UN*X, make sure that your
+     source code is always available in tar'ed and gzip'ed format
+     (.tar.gz). UNIX compress (.Z) has gone out of style and
+     usefulness and faster computers have brought bzip2 (.bz2) into
+     the spotlit as a more effective compression medium. I now make
+     all my releases available in both gzip'ed and bzip2'ed formats.
+    </para>
+
+    <para>
+     Binary packages are largely distribution specific. You can build
+     binary packages against a current version of a major
+     distribution, you will only make your users happy. Try to foster
+     relationships with users or developers of large distribution to
+     develop a system for consistent binary packages. It's often a
+     good idea to provide RedHat <acronym>RPM</acronym>'s (.rpm),
+     Debian deb's (.deb) and source <acronym>RPM</acronym>'s
+     <acronym>SRPM</acronym>'s. Binary packages can also be compiled
+     against a specified system with specificed libraries and
+     distributed in tar.gz format as well. <emphasis>Remember: While
+     these binaries packages are nice, geting the source packaged and
+     released should always be your priority. Other can and will do
+     the the binary packages for you.</emphasis>
+    </para>
+   </sect3>
+
+   <sect3>
+    <title>Useful tidbits and presentation hints</title>
+
+    <para>
+     <itemizedlist>
+
+      <listitem>
+       <para>
+        <emphasis>Make sure that your program can always be found in a
+        single location.</emphasis> Often this means that you have a
+        single directory accessable via <acronym>FTP</acronym> or
+        <acronym>HTTP</acronym> where the newest version will be
+        quickly recognized. One effective technique is a provide a
+        symlink called <quote>projectname-latest</quote> that is
+        always pointing to the most recent released or development
+        version of your free software project.
+       </para>
+      </listitem>
+
+      <listitem>
+       <para>
+        <emphasis>Make sure that there is a consistent email address
+        for bug reports.</emphasis> It's usually a good idea to make
+        this something that is NOT your primary email address like
+        projectname@host or projectname-bugs@host. This way if you
+        ever decide to hand over maintainership or if your email
+        address changes, you simply need to change where this email
+        address forwards to. It also will allow for more than one
+        person to deal with the influx of mail that is created if your
+        project becomes as huge as you hope it will.
+       </para>
+      </listitem>
 
 
+     </itemizedlist>
+    </para>
+
+   </sect3>
+  </sect2>
  </sect1>
 
 <!-- Section1: starting: END -->
  </sect1>
 
 <!-- Section1: starting: END -->
@@ -897,43 +1217,567 @@ for details.
 
  <sect1 id="developers">
   <title>Maintaining a Project: Interacting with Developers</title>
 
  <sect1 id="developers">
   <title>Maintaining a Project: Interacting with Developers</title>
-   <indexterm>
-    <primary>fswd!developers</primary>
-   </indexterm>
+  <indexterm>
+   <primary>fswd!developers</primary>
+  </indexterm>
+
+  <para>
+   Once you have gotten the project started, you have gotten over the
+   most difficult hurdles in the development process of your
+   program. Laying a firm foundation is essential, but the development
+   process itself is equally important and provides an equal number of
+   opportunities for failure. In the next two sections, I will and
+   cover running a project by discussing how to maintain a project
+   rhough interactions with developers and with users.
+  </para>
+
+  <para>
+   In releasing your program, your program becomes free software. This
+   transition is more than just a larger user base. By releasing your
+   program as free software, <emphasis>your</emphasis> software
+   becomes the <emphasis>free software community's</emphasis>
+   software. The direction of your software's development will be
+   reshaped, redirected, and fully determined by your users and, to a
+   larger extent, by other developers in the community.
+  </para>
+
+  <para>
+   The major difference between free software development and propriety
+   software development is the developer base. As the leader of a free
+   software project, you need to attract and keep developers in a way
+   that leaders of proprietary software projects sipmly don't have to
+   worry about. <emphasis>As the person leading development of a free
+   software project, you must harness the work of fellow developers by
+   making responsible decisions and by and by choosing not to make
+   decisions responsibly. You have to direct developers without being
+   overbearing or bossy. You need to strive to earn respect and never
+   forget to give it.</emphasis>
+  </para>
 
 <!-- Section2: delegation  -->
 
   <sect2 id="delegation">
    <title>Delegating Work</title>
 
 <!-- Section2: delegation  -->
 
   <sect2 id="delegation">
    <title>Delegating Work</title>
-   <para></para>
+
+   <para>
+    By now, you've hypothetically followed me through the early
+    writing of a piece of software, the creation of a website and
+    system of documentation and and we've gone ahead and (as will be
+    discussed in <xref linkend="releasing">) released it to the rest
+    of the world. Times passes, and if things go well, people become
+    interested and want to help. The patches begin flowing in.
+   </para>
+
+   <para>
+    <emphasis>Like the parent of any child who grows up, it's now time
+    to wince and smile and do most difficult thing in any parents
+    life: It's time to let go.</emphasis>
+   </para>
+
+   <para>
+    Delegation is the politcal way of describing this process of
+    <quote>letting go.</quote> It is the process of handing some of
+    the responsibility and power over your project to other reponsible
+    and involved developers. It is difficult for anyone who has
+    invested a large deal of time and energy into a project but it
+    essential for the growth of any free software project. One person
+    can only do so much. <emphasis>A free software project is nothing
+    without the involvement of a group of developers. A group of
+    developers can only be maintained through respectful and
+    responsible leadership and delegation.</emphasis>
+   </para>
+
+   <para>
+    As your project progresses, you will notice people who are putting
+    signfigant amounts of time and effort into your project. These
+    will be the people submitting the most patches, posting most on
+    the mailing lists, engaging in long email discussions. It is your
+    responsiblity to contact these people and to try and shift some of
+    the power and responsiblity of your position as the project's
+    maintainer onto them (if they want it). There are several easy
+    weays you can do this:
+   </para>
+
+   <sect3>
+    <title>How to delegate</title>
+    <para>
+     Like anything, its easier to see how others delegate than to do
+     it yourself. You may find that other developers seem even more
+     experienced or knowledgeable than you. Your job as a maintainer
+     does not mean you have to have to be the best or the
+     brightest. It means you need are responsible for showing good
+     judgement and for recognizing solutions that are maintainable and
+     are not. In a sentance: <emphasis>Keep an eye out for other
+     qualified developers who show an interest and sustained
+     involvement with your project and try and shift responsibility
+     towards them.</emphasis> The following ideas might be good places
+     to start or good sources of inspiriation:
+    </para>
+    <sect4>
+     <title>Allow a larger group of people write access to your CVS
+     reponsitory and make real efforts towards rule by a
+     committee</title>
+
+     <para>
+      <ulink url="http://httpd.apache.org/">Apache</ulink> is an
+      example of a project that is run by small group of developers
+      who vote on major technical issues and the admission of new
+      members and all have write access to the main source
+      repository. Their process is detailed <ulink
+      url="http://httpd.apache.org/ABOUT_APACHE.html">online.</ulink>
+     </para>
+
+     <para>
+      The <ulink url="http://www.debian.org/"> Debian Project</ulink>
+      is an extreme example of rule by committee. At current count,
+      more than 700 developers have full responsibility for certain
+      aspects of the projects. All these developers can upload into
+      the main ftp servers, and vote on major issues. Direction for
+      the project is determined by the project <ulink
+      url="http://www.debian.org/social_contract">social
+      contract</ulink> and a <ulink
+      url="http://www.debian.org/devel/constitution">constitution</ulink>. To
+      facilitate this system, there are special teams (i.e. the
+      install team, the Japanese language team) and a technical
+      committee and a project lead. There is a project lead as well
+      but the lead's main responsiblity is to, <quote>Appoint
+      Delegates or delegate decisions to the Technical
+      Committee.</quote>
+     </para>
+
+     <para>
+      While both of these projects operate on a scale that your
+      project will not (at least initially), their example is
+      helpful. Debian's idea of a project who lead who can do
+      <emphasis>nothing</emphasis> but delegate can serve as a
+      charicature of how a project can involve and empower a huge
+      number of developers and grow to a huge size.
+     </para>
+
+    </sect4>
+
+    <sect4 id="releasemanager">
+     <title>Publicly appoint someone as the release manager for a
+       specific release.</title>
+
+     <para>
+      A relase manager is usually responsible for coordinating
+      testing, encforcing a code freeze, being responsible for
+      stability and quality control, packaging up the software, and
+      placing it in the approrpriate places to be downloaded.
+     </para>
+
+     <para>
+      This use of the release manager is a good way to give yourself a
+      break and to shift the responsibility for accepting and
+      rejecting patches to somenoe else. It is a good way of very
+      clearly defining a chunk of work on the project as belonging to
+      a certain person and its a great way of giving yourself a break.
+     </para>
+    </sect4>
+
+    <sect4 id="delegatebranch">
+     <title>Delegate control of an entire branch.</title>
+     <para>
+      If your project chooses to have branches (as described in <xref
+      linkend="branches">), it might be a good idea to appoint someone
+      else to be the the head of a branch. If you like focusing your
+      energy on development releases and the implementation of new
+      features, had total control over the stable releases to a
+      well-suiteded developer.
+     </para>
+
+     <para>
+      The author of linux, Linus Torvalds, came out and crowned Alan
+      Cox as <quote>the man for stable kernels.</quote> All patches
+      for stable kernels go to Alan and, if Linus were to be taken
+      away from work on linux for any reason, Alan Cox would be more
+      than suited to fill his role as the acknowledged heir to the
+      linux maintainership.
+     </para>
+    </sect4>
+   </sect3> 
+  </sect2>
+
+<!-- Section2: patching -->
+
+  <sect2 id="patching">
+   <title>Accepting and Rejecting Patches</title>
+   <para>
+    This HOWTO has already touched on the fact that as the maintainer
+    of a free software project, one of primary and most important
+    responsibilities will be accepting and rejecting patches submitted
+    to you by other developers.
+   </para>
+
+   <sect3>
+    <title>Technical judgement</title>
+
+    <para>
+     In <emphasis>Open Source Development with CVS</emphasis>, Karl
+     Fogel makes a convincing argument that the most important things
+     to keep in mind are a firm knowledge of the scope of your program
+     (that's the <quote>idea</quote> I talked about in <xref
+     linkend="chooseproject">) and the ability to recognize,
+     facilitate, and direct <quote>evolution</quote> of a free
+     software program so that the program can grow and change and
+     incorporate functionatlity that was orignally unforseen but avoid
+     digressions that might expand the scope of the program too much
+     and result and push the project towards an early death under its
+     own weight and unweildiness. These are the criteria that you as a
+     project mainatiner should take into account each time you recieve
+     a patch.
+    </para>
+
+    <para>
+     Fogel elaborates on this again and states the <quote>the
+     questions to ask yourself when considering whether to implement
+     (or approve) a change are:</quote>
+    </para>
+
+    <para>
+     <itemizedlist>
+
+      <listitem>
+       <para>Will it benefit a significant percentage of the program's
+       user community?</para>
+      </listitem>
+
+      <listitem>
+       <para>Does it fit within the program's domain or within a
+       natural, intuitive extension of that domain?</para>
+      </listitem>
+
+     </itemizedlist>
+    </para>
+
+    <para>
+     The answers to these questions are never straighforward and its
+     very possible (and even likely) that the person who submitted the
+     patch may feel differently about the answer to those questions
+     than you do. However, if you feel that that the answer to either
+     of those questions is <quote>no,</quote> it is your responsiblity
+     to reject the change. If you fail to do this, the project will
+     become unweildy and unmaintainable and will ultimately fail.
+    </para>
+   </sect3>
+
+   <sect3>
+    <title>Rejecting patches</title>
+
+    <para>
+     Rejecting patches is probably the most difficult and the most
+     sesnative job that the maintainer of any free software project
+     has to face. But sometimes it has to be done. I mentioned earlier
+     (in <xref linkend="developers"> and in <xref
+     linkend="delegation">) that any developer needs to try and
+     balance your responsibility and power to make what you think are
+     the best technical decisions with the fact that you will lose
+     support from other developers if you seem like you are on a
+     powertrip or being overly bossy or possesive of a community-based
+     project. I recommend that you keep three major facts in mind when
+     rejecting patches (or other changes):
+    </para>
+
+    <sect4>
+     <title>Bring it to the community</title>
+     <para>
+      One of the best ways of justifying  a decision to reject a patch
+      and working  to  not seem like  you  keep an  iron grip  on your
+      project is by  not making the  decision  alone at all. It  might
+      make  sense  to  turn over  larger  proposed  changes  or more
+      difficult decisions to a development mailing list where they can
+      be discussed. There will be some patches (bug fixes, etc.) which
+      will  definately be accepted  and some that you  feel are so off
+      base that they do not even merit further discussion. It is those
+      that fall into the grey area between these two groups that might
+      merit a quick forward to a mailing list.
+     </para>
+
+     <para>
+      I recommend this process wholeheartedly. As the project
+      maintainer you are worried about making the best decision for
+      the project, for the project's users and developers, and for
+      yourself as a responsible project leader. Turning things over to
+      an email list will demonstrate your own responsible and
+      responsive leadership as it tests and serves the interests of
+      your software's community.
+     </para>
+    </sect4>
+
+    <sect4>
+     <title>Technical issues is not always good justification</title>
+     <para>
+      Especially towards the beginning, you will find that many
+      changes are difficult to implement, introduce new bugs, or have
+      other techincal problems. Try to see past these. Especially with
+      added functionality, good ideas do not always come from good
+      coders. Technical merit is a valid reason to postpone the
+      application of a patch but it is not always a good reason to
+      reject a change outright. Even small changes are worth the
+      effort of working with the submittor to iron out bugs and
+      incorporate the change if you thing you think it seems like a
+      good addition to your project. The effort on your part will work
+      to make your project a community project and it will pull a new
+      or less experienced developer onto your project and even teach
+      them something that might help them in their next patch.
+     </para>
+    </sect4>
+
+    <sect4>
+     <title>Common courtesy</title>
+     <para>
+      It should go without saying but, <emphasis>above all and in all
+      cases, just be nice.</emphasis> If someone has an idea and cares
+      about it enough to write some code and submit a patch, they
+      care, they are motivated, and they are already involved. Your
+      goal as the maintainer is make sure they submit again. They may
+      have thrown you a dud this time but next time may be the idea or
+      feature that revolutionizes your project. 
+     </para>
+
+     <para>
+      It is your responsibility to first justify your action to not
+      incorporate their change clearly and concisely. Then thank
+      them. Let them know that you a appreciate their help and feel
+      horrible that you can't incorproate their change. Let them know
+      that you look forward to their staying involved and you hope
+      that the next patch or idea meshes better with your project
+      because you appreciate their work and want to see it in the
+      project. If you have ever had a patch rejected that put a large
+      deal of time, thought, and energy into, you remember how it
+      feels and it feels bad. Keep this in mind when you have to let
+      someone down. It's never easy but you need to do everything you
+      have to make it as not-unpleasant as possible.
+     </para>
+    </sect4>
+   </sect3>
   </sect2>
 
 <!-- Section2: branches  -->
 
   <sect2 id="branches">
    <title>Stable and Development Branches</title>
   </sect2>
 
 <!-- Section2: branches  -->
 
   <sect2 id="branches">
    <title>Stable and Development Branches</title>
-   <para></para>
-  </sect2>
 
 
-<!-- Section2: freezing -->
+   <para>
+    The idea of stable and development branches has already been
+    described briefly in <xref linkend="chooseversioning"> and in
+    <xref linkend="delegatebranch">. These alluses attest to the fact
+    to some of the ways that multiple branches can affect your
+    software. Branches can let you avoid (to some extent) some of the
+    problems around rejecting patches (as described in <xref
+    linkend="patching">) by allowing you to temporarily compromise the
+    stability of your project without affected those users who need
+    that stability.
+   </para>
 
 
-  <sect2 id="freezing">
-   <title>Freezing</title>
-   <para></para>
-  </sect2>
+   <para>
+    The most common way of branching your project is to have one
+    branch that is stable and one that is development. This is the
+    model followed by the Linux kernel that is described in <xref
+    linkend="chooseversioning">. In this model, there is always one
+    branch that is stable and always one that is in
+    development. Before any new release, the development branch goes
+    into a <quote>feature freeze</quote> where major changes and added
+    features are rejected or put on hold under the development kernel
+    is released as the new stable branch and major development begins
+    again on the development branch. Bug fixes and small changes that
+    are unlikely to have any large negative reprocussion are
+    incorporated into the stable branch also to the development
+    branch.
+   </para>
 
 
-<!-- Section2: codecram -->
+   <para>
+    Linux's model is an extreme one. On many projects, there is no
+    need to have two versions always available. It may make sense ot
+    have two versions only near a release. The Debian project has
+    historically made both a stable and an unstable distribution
+    available but has expanded to this to include: stable, unstable,
+    testing, experimental, and (around release time) a frozen
+    distribution that only incorporates bug fixes during the
+    transition from unstable to stable. There are few projects whose
+    size would necessitate a system like Debian but their use of
+    branches helps demonstrate how they can be used to balance
+    consitent and effective development with the need to make regular
+    and useable releases.
+   </para>
+
+   <para>
+    In trying to set up a development tree for yourself, there are
+    several things that might be useful to keep in mind:
+   </para>
+
+   <para>
+    <variablelist>
+
+     <varlistentry>
+      <term>Minimize the number of branches</term>
+      <listitem>
+       <para>
+        Debian may be able to make good use of four or five branches
+        but it contains gigabytes of software in over 5000 packages
+        compiled for a 5-6 different architectures. Two is a good
+        number. Too many branches will confuse your users (I can't
+        count how many times I had to describe debian's system when it
+        only had 2 and sometimes 3 branches!), potential developers
+        and even yourself. Branches can help but they come at a cost
+        so use them very sparingly.
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term>Make sure that all your different branches are explained</term>
+      <listitem>
+       <para>
+        As I mentioned in the preceeding paragraph, different branches
+        <emphasis>will</emphasis> confuse your users. Do everything
+        you can to avoid this by clearly explaining the different
+        branches in a promenant page on your website and in a Readme
+        file in the <acronym>FTP</acronym> or <acronym>HTTP</acronym>
+        directory.
+       </para>
+
+       <para>
+        I might also recommend against a mistake that I think Debian
+        has made. The terms <quote>unstable,</quote>
+        <quote>testing,</quote> and <quote>experimental</quote> are
+        vague and difficult to rank in order of stability (or
+        instability as the case may be). Try explaining to someone
+        that <quote>stable</quote> actually means <quote>ultra
+        stable</quote> and that <quote>unstable</quote> doesn't
+        actually include any unstable software but is really stable
+        software that is untested as a distribution.
+       </para>
+
+       <para>
+        If you are going to do branches, especially early on, keep in
+        mind that people are conditioned to understand the terms
+        <quote>stable</quote> and <quote>development</quote> and you
+        probaly can't go wrong with this simple and common division of
+        branches.
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term>Make sure all your branches are always available</term>
+      <listitem>
+       <para>
+        Like a lot of document, this should probably should go without
+        saying but experience has taught me that it's not always
+        obvious to people. It's a good idea to physicall split up
+        different branches in different directories or directory trees
+        on your <acronym>FTP</acronym> or <acronym>HTTP</acronym>
+        site. Linux accomplishes this by having all the v2.2 and a
+        v2.3 subdirectory where it is immediately obvious (after you
+        know their version numbering scheme) which directory is the
+        most recent stable and the current development
+        releases. Debian accomplishes this by naming all their
+        distribution by name and then changing symlinks named
+        <quote>stable,</quote> <quote>unstable</quote> and
+        <quote>frozen</quote> to point to which ever distribution (by
+        name) is in whatever stage. Both methods work and their are
+        others. In any case, it is important that different branches
+        are always available, are accessable from consistent
+        locations, and that different branches are clearly
+        distinguished from each other so your users know exactly what
+        they want to be downloading and where to get it.
+       </para>
+      </listitem>
+     </varlistentry>
+
+    </variablelist>
+   </para>
 
 
-  <sect2 id="codecram">
-   <title>Avoiding the Code Cram Effect</title>
-   <para></para>
   </sect2>
 
   </sect2>
 
-<!-- Section2: patching -->
+<!-- Section2: otherdev -->
 
 
-  <sect2 id="patching">
-   <title>Accepting and Rejecting Patches</title>
-   <para></para>
+  <sect2 id="otherdev">
+   <title>Other Development issues</title>
+   <para>
+    There are more issues around surrounding interaction with
+    developers in a free software project that I can touch on in great
+    detail in a HOWTO of this size. Please don't hesitate to contact
+    me if you see any major omissions. Other smaller issues that are
+    worth mentioning are:
+   </para>
+
+   <sect3>
+    <title>Freezing</title>
+    <para>
+     For those projects that choose to adopt a split development model
+     (<xref linkend="branches">), freezing is a concept that is worth
+     becoming familiar with. 
+    </para>
+
+    <para>
+     Freeze come in two major forms. A <quote>feature freeze</quote>
+     is a period when no signifigant functionality is added to a
+     program. It is a period where established functionality (even
+     skeletons of barely working functionality) can be improved and
+     perfected. It is a period where bugs are fixed. This type of
+     freeze is usually applied some period (a month or two) before a
+     release. It is easy to push a release back as you wait for
+     <quote>one more feature</quote> and a freeze helps to avoid this
+     situation by drawing the much neede line in the sand. It gives
+     developers room they need to get a program ready for release.
+    </para>
+
+    <para>
+     The second type of freeze is a <quote>code freeze</quote> which
+     is much more like a released piece of software. Once a piece of
+     software has entered a code freeze, all changes to the code are
+     frowned upon and only changes that fix known bugs are
+     permitted. This type of freeze usually follows a <quote>feature
+     freeze</quote> and directly preceeds a release. Most released
+     software is in what could be interpreted as a sort of high
+     level<quote>code freeze.</quote>
+    </para>
+
+    <para>
+     Even you do not choose to appoint a release manager (<xref
+     linkend="releasemanager">), you will have an easier time
+     justifying the rejection or postponement of patches (<xref
+     linkend="patching"> before a release with a publicly stated
+     freeze in effect.
+    </para>
+   </sect3>
+
+   <sect3>
+    <title>Forking</title>
+    <para>
+     Forks are the most extreme interpretation of a branch. A fork is
+     when a group of developers takes code from a free software
+     project and actually starts a brand new free software
+     project. The most famous example of a fork is Emacs and
+     XEmacs. Both emacsen are based on an almost identical codebase
+     but for technical, political, and philisophical reasons,
+     development was split into two projects which now compete with
+     each other.
+    </para>
+
+    <para>
+     The short version of the fork section is, <emphasis>don't do
+     them.</emphasis> Forks force developers to choose one project to
+     work with, cause nasty political divisions, redundancy of work.
+     Luckily, usually the threat of the fork is enough to scare the
+     maintainer or maintainers of a project into changing the way they
+     run their project to avoid it.
+    </para>
+
+    <para>
+     In his chapter on <quote>The Open Source Process,</quote> Karl
+     Fogel describes how to do a fork if you absolutely must. If you
+     have determined that is absolutely necessary and that the
+     differences between you and the people threatening to fork are
+     absolutely unresolvable, I recommend Fogel's book as a good place
+     to start.
+    </para>
+   </sect3>
   </sect2>
  </sect1>
 
   </sect2>
  </sect1>
 
@@ -941,11 +1785,36 @@ for details.
 
  <sect1 id="users">
   <title>Maintaining a Project: Interacting with Users</title>
 
  <sect1 id="users">
   <title>Maintaining a Project: Interacting with Users</title>
+  <indexterm>
+   <primary>fswd!users</primary>
+  </indexterm>
 
 
-   <indexterm>
-    <primary>fswd!users</primary>
-   </indexterm>
+  <para>
+   If you've worked your way up to here, congratuatlions, you are
+   nearing the end of this document. This final section touches upon 
+  </para>
+
+
+<!-- Section2: testing -->
 
 
+  <sect2 id="testing">
+   <title>Testing and Testers</title>
+   <para></para>
+  </sect2>
+
+<!-- Section2: support  -->
+
+  <sect2 id="support">
+   <title>Setting up a Support Infrastructure</title>
+   <para></para>
+  </sect2>
+
+<!-- Section2: releasing  -->
+
+  <sect2 id="releasing">
+   <title>Releasing Your Program</title>
+   <para></para>
+  </sect2>
 
 <!-- Section2: announcing  -->
 
 
 <!-- Section2: announcing  -->
 
@@ -954,12 +1823,7 @@ for details.
    <para></para>
   </sect2>
 
    <para></para>
   </sect2>
 
-<!-- Section2: testing -->
 
 
-  <sect2 id="testing">
-   <title>Testing and Testers</title>
-   <para></para>
-  </sect2>
 </sect1>
 
 </article>
 </sect1>
 
 </article>

Benjamin Mako Hill || Want to submit a patch?