<?xml version="1.0" encoding="UTF-8"?><rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/">
  <channel>
    <title>OpenSource &amp;mdash; alan</title>
    <link>https://www.franzoni.eu/alan/tag:OpenSource</link>
    <description>Alan&#39;s musings</description>
    <language>en</language>
    <pubDate>Tue, 17 Nov 2026 01:04:50 +0000</pubDate>
    <item>
      <title>Building a successful community-driven software project: part 4</title>
      <link>https://www.franzoni.eu/alan/building-a-successful-community-driven-software-project-part-4</link>
      <description>&lt;![CDATA[This is a multipart post. See a href=&#34;/alan/building-a-successful-community-driven-software-project-part-3&#34;part 3/abr /br /Just a brief conclusion to my post sequence; the three principles for succeeding at community-driven projects are:br /br /br /ulliMake it easy for the people to give you their feedback - it&#39;s highly valuable./liliListen and reply to people&#39;s feedback. Don&#39;t do every-possible-requested-thing, but reply on time./liliDon&#39;t take any policy as a dogma. Everything can be changed./li/ul&#xA;&#xA;#Ollivander #community #OpenSource&#xA;]]&gt;</description>
      <content:encoded><![CDATA[<p>This is a multipart post. See <a href="/alan/building-a-successful-community-driven-software-project-part-3" rel="nofollow">part 3</a><br/><br/>Just a brief conclusion to my post sequence; the three principles for succeeding at community-driven projects are:<br/><br/><br/><ul><li>Make it easy for the people to give you their feedback – it&#39;s highly valuable.</li><li>Listen and reply to people&#39;s feedback. Don&#39;t do every-possible-requested-thing, but reply on time.</li><li>Don&#39;t take any policy as a dogma. Everything can be changed.</li></ul></p>

<p><a href="/alan/tag:Ollivander" class="hashtag" rel="nofollow"><span>#</span><span class="p-category">Ollivander</span></a> <a href="/alan/tag:community" class="hashtag" rel="nofollow"><span>#</span><span class="p-category">community</span></a> <a href="/alan/tag:OpenSource" class="hashtag" rel="nofollow"><span>#</span><span class="p-category">OpenSource</span></a></p>
]]></content:encoded>
      <guid>https://www.franzoni.eu/alan/building-a-successful-community-driven-software-project-part-4</guid>
      <pubDate>Fri, 22 Apr 2011 20:49:00 +0000</pubDate>
    </item>
    <item>
      <title>Building a successful community-driven software project: part 3</title>
      <link>https://www.franzoni.eu/alan/building-a-successful-community-driven-software-project-part-3</link>
      <description>&lt;![CDATA[div style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;This is a multipart post. See a href=&#34;/alan/building-a-successful-community-driven-software-project-part-2&#34;part 2/a/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;span class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;bbr //b/span/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;span class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;b6. State your mission/b/span/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;iWhat&#39;s your project for? Who should use it? Which platform is designed for?&amp;nbsp;/i/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Answer those questions somewhere in your project page. You won&#39;t risk people looking for the wrong solution coming to you and asking strange things, and you&#39;ll be able to dismiss requests as &#34;out of scope&#34; if they exceed your vision. bSharing such vision with your users is a necessity/b, or you&#39;ll be called a traitor by somebody, someday. As a user, I want to know what requirements was the project designed to accomodate. If I start building a large corporate webapp with tons of users around a small framework designed for personal, low-traffic blogs, I&#39;m probably doomed to fail./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;iWhat&#39;s you release policy? How do you manage API changes?&amp;nbsp;/i/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Explain how releases are done. Do you just keep a stable main branch and pull development and bugfix branches in it as soon as they&#39;re ready, so you just sometimes tag the main branch and have a release at that point? Or do you create milestone-oriented branches as soon as you release, e.g. version 1.0.0 is got a release-1.0 branch where you apply bugfixes only and release 1.0.1, 1.0.2 from that? Or have you got a &#34;stable&#34; release and a &#34;development&#34; release, but you sometimes pull stable features from development to stable?/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;All of that is important from the point of view of the user. I want to understand whether an API can change in an incompatible manner from 1.0.0 to 1.0.1. I want to know if I ever get a 1.0.1 release after 1.0.0 or I&#39;ll need to pick 1.1.0 with all its changes./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;span class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;b7. Have an homepage/b/span/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;And make it sure you provide its address in README files and such! You don&#39;t need a domain name, even though it makes things simpler. It doesn&#39;t need to be wonderful - a working one will suffice. You can use Google Sites, or any which Google Code, bitbucket or github provide out of the box./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;This may seem a stupid proposition, but in the modern era many users have access to the code for a project without having ever seen the project homepage - central repositories like&amp;nbsp;a href=&#34;http://pypi.python.org/&#34;cheeseshop/a&amp;nbsp;for Python and&amp;nbsp;a href=&#34;http://www.mavenrepository.com/&#34;maven/a&amp;nbsp;for Java make this possible.&amp;nbsp;&amp;nbsp;Then, when it&#39;s time to report an issue or ask a question, the user is puzzled and doesn&#39;t know where he should head to./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;bMake sure the homepage contains all the info a user needs/b. Where does discussion take place, how should I file a ticket, where are docs, what&#39;s the latest release, etcetera - everything should be linked there. Sometimes projects use multiple servers to store their data - the repo is on bitbucket.org, the mailing list on sourceforge.net, and the bugtracker is self-hosted. Of course it&#39;s better to disable whatever it&#39;s not in use, but the point it is:&amp;nbsp;bthe homepage should be the authoritative reference for everything regarding your project./b/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;i/iAnd keep it bupdated/b! That&#39;s why having a domain name of your own, or a subdomain - e.g. myproject.myowndomain.com - might be a good choice - you can just redirect people if your hosting goes down or you&#39;d like to change something./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Having stale information on your homepage will just delay people trying to help and maybe prevent some of them from telling you something. &amp;nbsp;I really hate when the homepage says the latest stable version is &#34;3.0.5&#34; but the central repo offers &#34;3.0.6&#34; - WTF? If you don&#39;t have the time to keep that in sync, just point to a webpage of the central repo and don&#39;t duplicate releases on your homepage - nobody says you must.br /br /Next: a href=&#34;/alan/building-a-successful-community-driven-software-project-part-4&#34;part 4/a/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdivibr //i/div&#xA;&#xA;#Ollivander #community #OpenSource&#xA;]]&gt;</description>
      <content:encoded><![CDATA[<div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">This is a multipart post. See <a href="/alan/building-a-successful-community-driven-software-project-part-2" rel="nofollow">part 2</a></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><span class="Apple-style-span" style="font-size: large;"><b><br/></b></span></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><span class="Apple-style-span" style="font-size: large;"><b>6. State your mission</b></span></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><i>What&#39;s your project for? Who should use it? Which platform is designed for? </i></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Answer those questions somewhere in your project page. You won&#39;t risk people looking for the wrong solution coming to you and asking strange things, and you&#39;ll be able to dismiss requests as &#34;out of scope&#34; if they exceed your vision. <b>Sharing such vision with your users is a necessity</b>, or you&#39;ll be called a traitor by somebody, someday. As a user, I want to know what requirements was the project designed to accomodate. If I start building a large corporate webapp with tons of users around a small framework designed for personal, low-traffic blogs, I&#39;m probably doomed to fail.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><i>What&#39;s you release policy? How do you manage API changes? </i></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Explain how releases are done. Do you just keep a stable main branch and pull development and bugfix branches in it as soon as they&#39;re ready, so you just sometimes tag the main branch and have a release at that point? Or do you create milestone-oriented branches as soon as you release, e.g. version 1.0.0 is got a release-1.0 branch where you apply bugfixes only and release 1.0.1, 1.0.2 from that? Or have you got a &#34;stable&#34; release and a &#34;development&#34; release, but you sometimes pull stable features from development to stable?</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">All of that is important from the point of view of the user. I want to understand whether an API can change in an incompatible manner from 1.0.0 to 1.0.1. I want to know if I ever get a 1.0.1 release after 1.0.0 or I&#39;ll need to pick 1.1.0 with all its changes.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><span class="Apple-style-span" style="font-size: large;"><b>7. Have an homepage</b></span></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">And make it sure you provide its address in README files and such! You don&#39;t need a domain name, even though it makes things simpler. It doesn&#39;t need to be wonderful - a working one will suffice. You can use Google Sites, or any which Google Code, bitbucket or github provide out of the box.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">This may seem a stupid proposition, but in the modern era many users have access to the code for a project without having ever seen the project homepage - central repositories like <a href="http://pypi.python.org/" rel="nofollow">cheeseshop</a> for Python and <a href="http://www.mavenrepository.com/" rel="nofollow">maven</a> for Java make this possible.  Then, when it&#39;s time to report an issue or ask a question, the user is puzzled and doesn&#39;t know where he should head to.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><b>Make sure the homepage contains all the info a user needs</b>. Where does discussion take place, how should I file a ticket, where are docs, what&#39;s the latest release, etcetera - everything should be linked there. Sometimes projects use multiple servers to store their data - the repo is on bitbucket.org, the mailing list on sourceforge.net, and the bugtracker is self-hosted. Of course it&#39;s better to disable whatever it&#39;s not in use, but the point it is: <b>the homepage should be the authoritative reference for everything regarding your project.</b></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><i></i>And keep it <b>updated</b>! That&#39;s why having a domain name of your own, or a subdomain - e.g. myproject.myowndomain.com - might be a good choice - you can just redirect people if your hosting goes down or you&#39;d like to change something.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Having stale information on your homepage will just delay people trying to help and maybe prevent some of them from telling you something.  I really hate when the homepage says the latest stable version is &#34;3.0.5&#34; but the central repo offers &#34;3.0.6&#34; - WTF? If you don&#39;t have the time to keep that in sync, just point to a webpage of the central repo and don&#39;t duplicate releases on your homepage - nobody says you must.<br/><br/>Next: <a href="/alan/building-a-successful-community-driven-software-project-part-4" rel="nofollow">part 4</a></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div><i><br/></i></div>

<p><a href="/alan/tag:Ollivander" class="hashtag" rel="nofollow"><span>#</span><span class="p-category">Ollivander</span></a> <a href="/alan/tag:community" class="hashtag" rel="nofollow"><span>#</span><span class="p-category">community</span></a> <a href="/alan/tag:OpenSource" class="hashtag" rel="nofollow"><span>#</span><span class="p-category">OpenSource</span></a></p>
]]></content:encoded>
      <guid>https://www.franzoni.eu/alan/building-a-successful-community-driven-software-project-part-3</guid>
      <pubDate>Tue, 01 Feb 2011 21:46:00 +0000</pubDate>
    </item>
    <item>
      <title>Building a successful community-driven software project: part 2</title>
      <link>https://www.franzoni.eu/alan/building-a-successful-community-driven-software-project-part-2</link>
      <description>&lt;![CDATA[This is a multipart article - link to a href=&#34;/alan/building-a-successful-community-driven-software-project-part-1&#34;part 1/abr /divbr //divdivdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;span class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;b3. Make it easy to report issues./b/span/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Yes, your software is got a bug. Never thought about it, didn&#39;t you? And here it is. /divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Now, busers shouldn&#39;t be forced to climb mountains in order to report it/b. You might not want it to be dealt with just in the discussion area, so a bug tracker is usually a good idea, but just like the discussion group, bquick access /bshould be allowed, either via anonymous issue reporting or using a backend supporting a decentralized authentication system. Remember, bany bug reporter is doing you a favor!/b You shouldn&#39;t ask too much to them./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Many large open source hosting platforms, like github, launchpad, bitbucket, google code, are great examples of how you can achieve this goal pretty easily./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;span class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;b4. Make it easy to submit bugfix patches./b/span/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;This is a big one, and I&#39;m sure many people won&#39;t agree with me./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Sometimes a patch comes along a bug report, yet many projects have got some coding standards, and they bdon&#39;t accept patches that don&#39;t follow such standards./b /divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Whew. /divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Many times, though, either the coding standard isn&#39;t really a widely accepted one, like a href=&#34;http://www.python.org/dev/peps/pep-0008/&#34;PEP-8/a for Python projects, but it&#39;s just how the lead developer likes to code, or many old parts of the codebase themselves don&#39;t follow such standard./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Hence, after I&#39;ve discovered a bug in your software, I&#39;ve debugged it, I&#39;ve tracked it down and now I&#39;m providing you a patch, you&#39;re rejecting it on a mostly cosmetic base because of some principles you alone chose to follow. Thank you very much sir, you&#39;re so nice to me. Don&#39;t call me by the way, I&#39;ll call you if I update my patch to achieve your great coding perfection./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;The whole point is, byour coding standards are your business. /bNever forget the a href=&#34;http://programmer.97things.oreilly.com/wiki/index.php/TheBoyScout_Rule&#34;Boy Scout rule/a - iyou don&#39;t have to make every module perfect before you check it in. /iRemoving a bug is enough of an improvement to let a patch be accepted. If you don&#39;t want non-complaint code in your codebase just edit the patch - it should be easy for you - don&#39;t reject it and don&#39;t ask the reporter to edit it./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Of course there are perfectly good reasons to reject a patch. If it&#39;s a &#34;worst hack ever&#34; style of patch, or if it adds unnecessary complexity, provokes unintended side effects or changes a behaviour on which existing clients rely, just do whatever you think it&#39;s right./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;There&#39;s another top rejection reason:  bmissing unit tests /bor binsufficient coverage./b Some projects with high coding standards require a unit test for each functionality and maybe 100% test coverage. It&#39;s perfectly fine, but there&#39;re issues with this choice./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Very often there&#39;re some legacy parts of the codebase that have got little test coverage; in order to achieve 100% test coverage the reporter might be forced to create a unit test that does not exist for some code that he has not written. That&#39;s a burden and most people will get discouraged./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Other times the overall design in some parts of the code does not allow for easy dependency injection, hence making it hard to create a good unit test which can really test the specific behaviour being patched, and the reporter might be able to reproduce the issue only with an higher-level, more integration-level-like test example./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;In both those cases you should remember that bthe quality of your codebase is your business. /bYou should not reject a patch from being applied because there&#39;re no unit tests if creating such a unit test is impractical and the fault is yours. Of course byou can create a guideline for patch submission/b that says that you prefer the issues to be reproduced via a unit test, but don&#39;t make it a strict requirement. A patch without a test is better than nothing, you might just pick it up later when you&#39;ve got some time and write a test for it./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Of course if a patch does not convince you for any reason and you don&#39;t get a unit test, just don&#39;t apply it - but don&#39;t be a a href=&#34;http://www.amazon.com/Adrenaline-Junkies-Template-Zombies-Understanding/dp/0932633676&#34;template zombie/a - i.e. don&#39;t place policies ahead of people./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;If you&#39;re unable to reproduce a problem because it happens in scenario you aren&#39;t able to test, try checking whether the patch causes any drawback to your supported scenarios. If it doesn&#39;t, you might decide to just trust the reporter./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Feature patches are a completely different story IMHO - when you accept something new in your codebase you should  be able to dictate whatever you want./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;span class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;b5. Reply to issues /b/span/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;Reply to issues. Always. If possible, do it in a reasonable amount of time, which should be, in my opinion, ten days at a maximum. iYou don&#39;t have to take immediate action. /iYour reply could just be iInvestigating the issue /ior something like that. Remember the a href=&#34;http://jeremy.zawodny.com/blog/archives/009311.html&#34;Inbox Zero/a approach to GTD: don&#39;t let unread, unaccepted bug tickets linger in your bugtracker! A lingering ticket is the first stop on the path to killing community support to your project./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;The same approach is valid for issues with an attached patch - say something. iDon&#39;t let issues linger unanswered./i/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;ibr //i/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;And never, never iwake up after a bug has been lingering for months just to ask the reporter if it &#34;still applies&#34;!/i This is terrible, I hate it when it happens. &#34;Sorry, being too busy but did 37 releases of my software in the meantime, could you check if this still happens with the latest?&#34;. You&#39;re probably in a better position for verifying the issue - assuming that a way to reproduce it is provided - on any release, since you made them./divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;The next part will deal with APIs and public info for your project - see a href=&#34;/alan/building-a-successful-community-driven-software-project-part-3&#34;part 3/a/divdiv style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;br //div/div&#xA;&#xA;#Ollivander #community #OpenSource&#xA;]]&gt;</description>
      <content:encoded><![CDATA[<p>This is a multipart article – link to <a href="/alan/building-a-successful-community-driven-software-project-part-1" rel="nofollow">part 1</a><br/><div><br/></div><div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><span class="Apple-style-span" style="font-size: large;"><b>3. Make it easy to report issues.</b></span></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Yes, your software is got a bug. Never thought about it, didn&#39;t you? And here it is. </div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Now, <b>users shouldn&#39;t be forced to climb mountains in order to report it</b>. You might not want it to be dealt with just in the discussion area, so a bug tracker is usually a good idea, but just like the discussion group, <b>quick access </b>should be allowed, either via anonymous issue reporting or using a backend supporting a decentralized authentication system. Remember, <b>any bug reporter is doing you a favor!</b> You shouldn&#39;t ask too much to them.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Many large open source hosting platforms, like github, launchpad, bitbucket, google code, are great examples of how you can achieve this goal pretty easily.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><span class="Apple-style-span" style="font-size: large;"><b>4. Make it easy to submit bugfix patches.</b></span></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">This is a big one, and I&#39;m sure many people won&#39;t agree with me.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Sometimes a patch comes along a bug report, yet many projects have got some coding standards, and they <b>don&#39;t accept patches that don&#39;t follow such standards.</b> </div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Whew. </div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Many times, though, either the coding standard isn&#39;t really a widely accepted one, like <a href="http://www.python.org/dev/peps/pep-0008/" rel="nofollow">PEP-8</a> for Python projects, but it&#39;s just how the lead developer likes to code, or many old parts of the codebase themselves don&#39;t follow such standard.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Hence, after I&#39;ve discovered a bug in your software, I&#39;ve debugged it, I&#39;ve tracked it down and now I&#39;m providing you a patch, you&#39;re rejecting it on a mostly cosmetic base because of some principles you alone chose to follow. Thank you very much sir, you&#39;re so nice to me. Don&#39;t call me by the way, I&#39;ll call you if I update my patch to achieve your great coding perfection.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">The whole point is, <b>your coding standards are your business. </b>Never forget the <a href="http://programmer.97things.oreilly.com/wiki/index.php/The_Boy_Scout_Rule" rel="nofollow">Boy Scout rule</a> - <i>you don&#39;t have to make every module perfect before you check it in. </i>Removing a bug is enough of an improvement to let a patch be accepted. If you don&#39;t want non-complaint code in your codebase just edit the patch – it should be easy for you – don&#39;t reject it and don&#39;t ask the reporter to edit it.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Of course there are perfectly good reasons to reject a patch. If it&#39;s a “worst hack ever” style of patch, or if it adds unnecessary complexity, provokes unintended side effects or changes a behaviour on which existing clients rely, just do whatever you think it&#39;s right.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">There&#39;s another top rejection reason:  <b>missing unit tests </b>or <b>insufficient coverage.</b> Some projects with high coding standards require a unit test for each functionality and maybe 100% test coverage. It&#39;s perfectly fine, but there&#39;re issues with this choice.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Very often there&#39;re some legacy parts of the codebase that have got little test coverage; in order to achieve 100% test coverage the reporter might be forced to create a unit test that does not exist for some code that he has not written. That&#39;s a burden and most people will get discouraged.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Other times the overall design in some parts of the code does not allow for easy dependency injection, hence making it hard to create a good unit test which can really test the specific behaviour being patched, and the reporter might be able to reproduce the issue only with an higher-level, more integration-level-like test example.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">In both those cases you should remember that <b>the quality of your codebase is your business. </b>You should not reject a patch from being applied because there&#39;re no unit tests if creating such a unit test is impractical and the fault is yours. Of course <b>you can create a guideline for patch submission</b> that says that you prefer the issues to be reproduced via a unit test, but don&#39;t make it a strict requirement. A patch without a test is better than nothing, you might just pick it up later when you&#39;ve got some time and write a test for it.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Of course if a patch does not convince you for any reason and you don&#39;t get a unit test, just don&#39;t apply it – but don&#39;t be a <a href="http://www.amazon.com/Adrenaline-Junkies-Template-Zombies-Understanding/dp/0932633676" rel="nofollow">template zombie</a> - i.e. don&#39;t place policies ahead of people.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">If you&#39;re unable to reproduce a problem because it happens in scenario you aren&#39;t able to test, try checking whether the patch causes any drawback to your supported scenarios. If it doesn&#39;t, you might decide to just trust the reporter.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Feature patches are a completely different story IMHO – when you accept something new in your codebase you should  be able to dictate whatever you want.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><span class="Apple-style-span" style="font-size: large;"><b>5. Reply to issues </b></span></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">Reply to issues. Always. If possible, do it in a reasonable amount of time, which should be, in my opinion, ten days at a maximum. <i>You don&#39;t have to take immediate action. </i>Your reply could just be <i>Investigating the issue </i>or something like that. Remember the <a href="http://jeremy.zawodny.com/blog/archives/009311.html" rel="nofollow">Inbox Zero</a> approach to GTD: don&#39;t let unread, unaccepted bug tickets linger in your bugtracker! A lingering ticket is the first stop on the path to killing community support to your project.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">The same approach is valid for issues with an attached patch – say something. <i>Don&#39;t let issues linger unanswered.</i></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><i><br/></i></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">And never, never <i>wake up after a bug has been lingering for months just to ask the reporter if it “still applies”!</i> This is terrible, I hate it when it happens. “Sorry, being too busy but did 37 releases of my software in the meantime, could you check if this still happens with the latest?”. You&#39;re probably in a better position for verifying the issue – assuming that a way to reproduce it is provided – on any release, since you made them.</div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;">The next part will deal with APIs and public info for your project – see <a href="/alan/building-a-successful-community-driven-software-project-part-3" rel="nofollow">part 3</a></div><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><br/></div></div></p>

<p><a href="/alan/tag:Ollivander" class="hashtag" rel="nofollow"><span>#</span><span class="p-category">Ollivander</span></a> <a href="/alan/tag:community" class="hashtag" rel="nofollow"><span>#</span><span class="p-category">community</span></a> <a href="/alan/tag:OpenSource" class="hashtag" rel="nofollow"><span>#</span><span class="p-category">OpenSource</span></a></p>
]]></content:encoded>
      <guid>https://www.franzoni.eu/alan/building-a-successful-community-driven-software-project-part-2</guid>
      <pubDate>Sun, 02 Jan 2011 21:38:00 +0000</pubDate>
    </item>
    <item>
      <title>Building a successful community-driven software project: part 1</title>
      <link>https://www.franzoni.eu/alan/building-a-successful-community-driven-software-project-part-1</link>
      <description>&lt;![CDATA[There&#39;s a lot of buzz about open source software lately. Many projects are supposed to embrace the a href=&#34;http://en.wikipedia.org/wiki/TheCathedralandtheBazaar&#34;Bazaar development model/a, but they really don&#39;t, and their leaders just seem to ignore users a lot. This often leads both to wild forking - one new feature, one new fork that&#39;s never merged in the original code base - and to multiple incomplete implementations - there&#39;re many projects to satisfy a single need, but none of them is complete.br /br /What should you do to make your project successful? Those are my guidelines. I&#39;ve split the post into pieces since it was growing too large for a single entry.br /br /This is mostly developer-oriented; I think supporting a community of end-users might be slightly different, although concerns might sometimes be similar.br /bbr //bbr /bspan class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;1. Make it easy to discuss about your software./span/bbr /Something might not be clear about your software, whether it&#39;s usage, availability, license, scope, and so on. It must be easy to ask a question, whether it&#39;s on a mailing list, on a forum or by any other mean - a href=&#34;https://answers.launchpad.net/&#34;Launchpad Answers/a or a href=&#34;http://getsatisfaction.com/&#34;GetSatifaction/a are good alternatives - just bdon&#39;t make it too hard/b to just ask a question!br /br / If you&#39;re using a custom forum or any other portal, bmake sure it supports a decentralized authentication system/b, be it OpenID, Google Account, MSN or whatever you like. Very often creating a new username/password couplet, fill in a few forms, clicking to verify an email, etc. etc. may just be btoo much an hassle /bfor somebody who just wants to ask a small question.br /br /Similarly, if you&#39;re using a mailing list, make sure bit&#39;s not too hard to get subscribed/b; if possible, just let anyone post a question - then a &#34;reply all&#34; from any list subscriber should reach the poster. Don&#39;t moderate subscriptions and posts unless you&#39;ve got a really good reason to - e.g. too much spam that automatic filters can&#39;t handle. Consider using mailing list providers that make it easy to use the ML from the web as well - a href=&#34;http://groups.yahoo.com/&#34;Yahoo Groups/a and a href=&#34;http://groups.google.com/&#34;Google Groups/a are great examples; they&#39;ll give a great overall user experience, and satisfy those who prefer forums and those who prefer mailing lists at the very same time.br /span class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;bbr //b/spanbr /span class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;b2. Answer questions and doubts./b/spanbr /This seems a silly one, but it isn&#39;t. bMake sure users get a minimum of feedback, /bbe it just a &#34;read the FAQ&#34;, or &#34;it&#39;s not implemented yet&#34; or &#34;I don&#39;t know&#34;. Any message left lingering is a big thumbs down for your project.br /ispan class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;bspan class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;bbr //b/span/b/span/ibr /span class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;bspan class=&#34;Apple-style-span&#34; style=&#34;font-size: large;&#34;b3. Have a FAQ/b/span/b/spanbr /div style=&#34;margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;&#34;span class=&#34;Apple-style-span&#34;This was pretty common during the nineties, I can remember being turned down with a &#34;Read the FAQ&#34; many times when I was young and inexperienced, but it&#39;s not such frequent thing anymore. There&#39;re some questions that get asked again and again. If you don&#39;t mantain a FAQ you can&#39;t tell people &#34;Read the FAQ!&#34;, and you&#39;ll need to answer the same question again, and again, and again. And you won&#39;t like it./spanbr /span class=&#34;Apple-style-span&#34;br //spanbr /span class=&#34;Apple-style-span&#34;Link to a href=&#34;/alan/building-a-successful-community-driven-software-project-part-2&#34;part 2/a - bug reporting and patch submission./spanbr /br //div&#xA;&#xA;#Ollivander #community #OpenSource&#xA;]]&gt;</description>
      <content:encoded><![CDATA[<p>There&#39;s a lot of buzz about open source software lately. Many projects are supposed to embrace the <a href="http://en.wikipedia.org/wiki/The_Cathedral_and_the_Bazaar" rel="nofollow">Bazaar development model</a>, but they really don&#39;t, and their leaders just seem to ignore users a lot. This often leads both to wild forking – one new feature, one new fork that&#39;s never merged in the original code base – and to multiple incomplete implementations – there&#39;re many projects to satisfy a single need, but none of them is complete.<br/><br/>What should you do to make your project successful? Those are my guidelines. I&#39;ve split the post into pieces since it was growing too large for a single entry.<br/><br/>This is mostly developer-oriented; I think supporting a community of end-users might be slightly different, although concerns might sometimes be similar.<br/><b><br/></b><br/><b><span class="Apple-style-span" style="font-size: large;">1. Make it easy to discuss about your software.</span></b><br/>Something might not be clear about your software, whether it&#39;s usage, availability, license, scope, and so on. It must be easy to ask a question, whether it&#39;s on a mailing list, on a forum or by any other mean – <a href="https://answers.launchpad.net/" rel="nofollow">Launchpad Answers</a> or <a href="http://getsatisfaction.com/" rel="nofollow">GetSatifaction</a> are good alternatives – just <b>don&#39;t make it too hard</b> to just ask a question!<br/><br/> If you&#39;re using a custom forum or any other portal, <b>make sure it supports a decentralized authentication system</b>, be it OpenID, Google Account, MSN or whatever you like. Very often creating a new username/password couplet, fill in a few forms, clicking to verify an email, etc. etc. may just be <b>too much an hassle </b>for somebody who just wants to ask a small question.<br/><br/>Similarly, if you&#39;re using a mailing list, make sure <b>it&#39;s not too hard to get subscribed</b>; if possible, just let anyone post a question – then a “reply all” from any list subscriber should reach the poster. Don&#39;t moderate subscriptions and posts unless you&#39;ve got a really good reason to – e.g. too much spam that automatic filters can&#39;t handle. Consider using mailing list providers that make it easy to use the ML from the web as well – <a href="http://groups.yahoo.com/" rel="nofollow">Yahoo Groups</a> and <a href="http://groups.google.com/" rel="nofollow">Google Groups</a> are great examples; they&#39;ll give a great overall user experience, and satisfy those who prefer forums and those who prefer mailing lists at the very same time.<br/><span class="Apple-style-span" style="font-size: large;"><b><br/></b></span><br/><span class="Apple-style-span" style="font-size: large;"><b>2. Answer questions and doubts.</b></span><br/>This seems a silly one, but it isn&#39;t. <b>Make sure users get a minimum of feedback, </b>be it just a “read the FAQ”, or “it&#39;s not implemented yet” or “I don&#39;t know”. Any message left lingering is a big thumbs down for your project.<br/><i><span class="Apple-style-span" style="font-size: large;"><b><span class="Apple-style-span" style="font-size: large;"><b><br/></b></span></b></span></i><br/><span class="Apple-style-span" style="font-size: large;"><b><span class="Apple-style-span" style="font-size: large;"><b>3. Have a FAQ</b></span></b></span><br/><div style="margin-bottom: 0px; margin-left: 0px; margin-right: 0px; margin-top: 0px;"><span class="Apple-style-span">This was pretty common during the nineties, I can remember being turned down with a “Read the FAQ” many times when I was young and inexperienced, but it&#39;s not such frequent thing anymore. There&#39;re some questions that get asked again and again. If you don&#39;t mantain a FAQ you can&#39;t tell people “Read the FAQ!”, and you&#39;ll need to answer the same question again, and again, and again. And you won&#39;t like it.</span><br/><span class="Apple-style-span"><br/></span><br/><span class="Apple-style-span">Link to <a href="/alan/building-a-successful-community-driven-software-project-part-2" rel="nofollow">part 2</a> - bug reporting and patch submission.</span><br/><br/></div></p>

<p><a href="/alan/tag:Ollivander" class="hashtag" rel="nofollow"><span>#</span><span class="p-category">Ollivander</span></a> <a href="/alan/tag:community" class="hashtag" rel="nofollow"><span>#</span><span class="p-category">community</span></a> <a href="/alan/tag:OpenSource" class="hashtag" rel="nofollow"><span>#</span><span class="p-category">OpenSource</span></a></p>
]]></content:encoded>
      <guid>https://www.franzoni.eu/alan/building-a-successful-community-driven-software-project-part-1</guid>
      <pubDate>Sun, 19 Dec 2010 21:27:00 +0000</pubDate>
    </item>
  </channel>
</rss>