Documentation/included/helpus.itexi

   1 @c -*- coding: utf-8; mode: texinfo; -*-
   2 @c This file is part of web/community.itexi and
   3 @c contributor/introduction.itely
   4
   5 @macro helpusNeed
   6 @subheading We need you!
   7
   8 Thank you for your interest in helping us --- we would love to see
   9 you get involved!  Your contribution will help a large group of users
  10 make beautifully typeset music.
  11
  12 Even working on small tasks can have a big impact: taking care of
  13 them allows experienced developers work on advanced tasks, instead
  14 of spending time on those simple tasks.
  15
  16 For a multi-faceted project like LilyPond, sometimes it's tough to know
  17 where to begin.  In addition to the avenues proposed below, you can send
  18 an e-mail to the @email{mike@@mikesolomon.org, Frog meister}
  19 letting him know your skill set and asking how you can help or proposing a
  20 project.  He'll be able to give you guidance on how to get started.
  21
  22 @end macro
  23
  24
  25 @macro helpusSimple
  26 @subheading Simple tasks
  27
  28 @strong{No programming skills} required!
  29
  30 @itemize
  31 @item
  32 Mailing list support: answer questions from fellow users.
  33
  34 @item
  35 Bug reporting: help users create proper @rweb{Bug reports}, and/or
  36 join the Bug Squad to organize @rcontrib{Issues}.
  37
  38 @item
  39 @rcontrib{Grand Regression Test Checking}: verify that LilyPond works correctly
  40 by examining output of test snippets.  Checking one snippet takes less
  41 than a minute!
  42
  43 @item
  44 Documentation: small changes can be proposed by following the
  45 guidelines for @rcontrib{Documentation suggestions}.
  46
  47 @item
  48 LilyPond Snippet Repository (LSR): create and fix snippets
  49 following the guidelines in
  50 @rcontrib{Adding and editing snippets}.
  51
  52 @item
  53 Discussions, reviews, and testing: the developers often ask for
  54 feedback about new documentation, potential syntax changes, and
  55 testing new features.  Please contribute to these discussions!
  56
  57 @end itemize
  58
  59 @end macro
  60
  61
  62 @macro helpusAdvanced
  63 @subheading Advanced tasks
  64
  65 These jobs generally require that you have the source code and can
  66 compile LilyPond.
  67
  68 @warning{We suggest that contributors using Windows or MacOS X do
  69 @strong{not} attempt to set up their own development environment;
  70 instead, use Lilydev as discussed in @rcontrib{Quick start}.}
  71
  72 Contributors using Linux or FreeBSD may also use Lilydev, but if
  73 they prefer their own development environment, they should read
  74 @rcontrib{Working with source code}, and @rcontrib{Compiling}.
  75
  76 Begin by reading @rcontrib{Summary for experienced developers}.
  77
  78 @itemize
  79 @item
  80 Documentation: for large changes, see
  81 @rcontrib{Documentation work}.
  82
  83 @item
  84 Website: the website is built from the normal documentation
  85 source.  See the info about documentation, and also
  86 @rcontrib{Website work}.
  87
  88 @item
  89 Translations: see @rcontrib{Translating the documentation}, and
  90 @rcontrib{Translating the website}.
  91
  92 @item
  93 Bugfixes or new features: the best way to begin is to join the
  94 Frogs, and read @rcontrib{Programming work}.
  95
  96 @end itemize
  97
  98 @end macro
  99
 100 @ignore
 101 @macro helpusProjects
 102 @subheading Projects
 103
 104 @subsubheading Frogs
 105
 106 Website and mailing list:
 107
 108 @example
 109 @uref{http://frogs.lilynet.net}
 110 @end example
 111
 112 The Frogs are ordinary LilyPond users who have chosen to get
 113 involved in their favorite software's development.  Fixing bugs,
 114 implementing new features, documenting the source code: there's a
 115 lot to be done, but most importantly: this is a chance for
 116 everyone to learn more about LilyPond, about Free Software, about
 117 programming@dots{} and to have fun.  If you're curious about any of
 118 it, then the word is: @emph{Join the Frogs!}
 119
 120
 121
 122 @subsubheading Grand LilyPond Input Syntax Standardization
 123
 124 Website:
 125 @rcontrib{Grand LilyPond Input Syntax Standardization (GLISS)}.
 126
 127 GLISS will stabilize the (non-tweak) input syntax for the upcoming
 128 LilyPond 3.0.  After updating to 3.0, the input syntax for
 129 untweaked music will remain stable for the foreseeable future.
 130
 131 We will have an extensive discussion period to determine the final
 132 input specification.
 133
 134 @warning{GLISS will start shortly after 2.16 is released.}
 135
 136 @subsubheading Grand Organizing Project
 137
 138 Website: @rcontrib{Grand Organization Project (GOP)}.
 139
 140 GOP will be our big recruiting drive for new contributors.  We
 141 desperately need to spread the development duties (including
 142 @qq{simple tasks} which require no programming or interaction with
 143 source code!) over more people.  We also need to document
 144 knowledge from existing developers so that it does not get lost.
 145
 146 Unlike most @qq{Grand Projects}, GOP is not about adding huge new
 147 features or completely redesigning things.  Rather, it is aimed at
 148 giving us a much more stable foundation so that we can move ahead
 149 with larger tasks in the future.
 150
 151 @end macro
 152
 153 @end ignore
 154