docs/gnu/CONTRIBUTING.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4
   5 <chapter id="CONTRIBUTING">
   6 <title>How to contribute</title>
   7 <subtitle>How you can help the ADG canvas project</subtitle>
   8
   9 <para>The ADG canvas is a relatively young and little project: any help
  10 will be appreciated. This document shows a (non-exhaustive) list of
  11 ways on how you can contribute. For any question or suggestion, fill
  12 free to <ulink url="http://lists.sourceforge.net/lists/listinfo/adg-devel">contact us</ulink>.</para>
  13
  14 <simplesect id="CONTRIBUTING.spread">
  15 <title>Spread the word</title>
  16
  17 <para>The easiest way to contribute is to let the other know of the ADG
  18 existence. Blog about it, bookmark the home page, suggest it as an
  19 alternative to any potential user.</para>
  20
  21 <para>Objectively, the ADG canvas is a niche project and there is nothing
  22 can be done about it. The target audience is a software developer
  23 with technical design knowledge or a designer with development skills,
  24 and I bet there are not many of them around.</para>
  25
  26 <para>A community, in the open source meaning, will be quite difficult to
  27 achieve but the project itself is really innovative and there is no
  28 other similar alternative I am aware of in the free software world.</para>
  29
  30 </simplesect>
  31
  32 <simplesect id="CONTRIBUTING.reporting">
  33 <title>Report any errors and issues or suggest new features</title>
  34
  35 <para>Use the <ulink url="http://dev.entidi.com/p/adg/issues/">bug tracker</ulink> to report
  36 any bugs you find in the project while using it. The tracker is also
  37 opened to suggestions or feature requests: just register yourself and
  38 report whatever you fill useful.</para>
  39
  40 <para>If you want to be up to date with the development status or intend
  41 to use the ADG canvas seriously, please consider joining the
  42 <ulink url="http://lists.sourceforge.net/lists/listinfo/adg-devel">mailing list</ulink>.
  43 This is the main source of information where discussion about the
  44 future of the project will take place.</para>
  45
  46 </simplesect>
  47
  48 <simplesect id="CONTRIBUTING.localization">
  49 <title>Translation of the ADG messages</title>
  50
  51 <para>ADG is a library so this is not a big issue. Anyway, as soon as the
  52 <ulink url="http://dev.entidi.com/p/adg/issues/13/">gettext support</ulink> will be added,
  53 fill free to translate it and submit the result in any way you fill
  54 comfortable with. The procedure is pretty straight forward and the
  55 <ulink url="http://en.wikipedia.org/wiki/GNU_gettext">wikipedia page</ulink> provides a
  56 good introduction on the gettext usage. This section will be improved
  57 with further details as soon as the gettext support will be added.</para>
  58
  59 </simplesect>
  60
  61 <simplesect id="CONTRIBUTING.code">
  62 <title>Patches welcome (obviously)</title>
  63
  64 <para>The ADG canvas is a free project (as in speech <emphasis>and</emphasis> as in beer): any
  65 code contribution will be publicly shared. For technical details on
  66 the way the code is implemented in the ADG project, please consult
  67 the <ulink url="http://adg.entidi.com/api/view/HACKING.html">dedicated section</ulink>.</para>
  68 </simplesect>
  69 </chapter>