Documentation/contributor/introduction.itexi

   1 @c -*- coding: utf-8; mode: texinfo; -*-
   2
   3 @include included/helpus.itexi
   4
   5 @node Introduction to contributing
   6 @chapter Introduction to contributing
   7
   8 This chapter presents a quick overview of ways that people can
   9 help LilyPond.
  10
  11 @menu
  12 * Help us::
  13 * Overview of work flow::
  14 * Lilybuntu::
  15 * Mentors::
  16 @end menu
  17
  18
  19 @node Help us
  20 @section Help us
  21
  22 @helpusNeed
  23
  24 @helpusTasks
  25
  26 @helpusProjects
  27
  28
  29 @node Overview of work flow
  30 @section Overview of work flow
  31
  32 @cartouche
  33 @strong{Ultra-short summary for Unix developers}: source code is at
  34 @code{git://git.sv.gnu.org/lilypond.git}.  Documentation is built
  35 with Texinfo, after pre-processing with @code{lilypond-book}.
  36 Send well-formed patches to @email{lilypond-devel@@gnu.org}.
  37 @end cartouche
  38
  39 Git is a @emph{version control system} that tracks the history of
  40 a program's source code.  The LilyPond source code is maintained
  41 as a Git repository, which contains:
  42
  43 @itemize
  44 @item
  45 all of the source files needed to build LilyPond, and
  46
  47 @item
  48 a record of the entire history of every change made to every file
  49 since the program was born.
  50 @end itemize
  51
  52 The @q{official} LilyPond Git repository is hosted by the GNU
  53 Savannah software forge at @uref{http://git.sv.gnu.org}.
  54 Although, since Git uses a @emph{distributed} model, technically
  55 there is no central repository.  Instead, each contributor keeps a
  56 complete copy of the entire repository (about 116M).
  57
  58 Changes made within one contributor's copy of the repository can
  59 be shared with other contributors using @emph{patches}.  A patch
  60 is a simple text file generated by the @command{git} program that
  61 indicates what changes have been made (using a special format).
  62 If a contributor's patch is approved for inclusion (usually
  63 through the mailing list), someone on the current development team
  64 will @emph{push} the patch to the official repository.
  65
  66 The Savannah software forge provides two separate interfaces for
  67 viewing the LilyPond Git repository online: @emph{cgit} and
  68 @emph{gitweb}.  The cgit interface should work faster than gitweb
  69 in most situations, but only gitweb allows you to search through
  70 the source code using @command{grep}, which you may find useful.
  71 The cgit interface is at
  72 @uref{http://git.sv.gnu.org/cgit/lilypond.git/} and the gitweb
  73 interface is at
  74 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git}.
  75
  76 Git is a complex and powerful tool, but tends to be confusing at
  77 first, particularly for users not familiar with the command line
  78 and/or version control systems.  Contributors who don't want to
  79 deal with Git directly are encouraged to use the
  80 @command{lily-git} graphical user interface instead.
  81
  82 @emph{Compiling} (@q{building}) LilyPond allows developers to see
  83 how changes to the source code affect the program itself.
  84 Compiling is also needed to package the program for specific
  85 operating systems or distributions.  LilyPond can be compiled from
  86 a local Git repository (for developers), or from a downloaded
  87 tarball (for packagers).  Compiling LilyPond is a rather involved
  88 process, and most contributor tasks do not require it.
  89
  90 Contributors can contact the developers through the
  91 @q{lilypond-devel} mailing list.  The mailing list archive is
  92 located at
  93 @uref{http://lists.gnu.org/archive/html/lilypond-devel/}.  If you
  94 have a question for the developers, search the archives first to
  95 see if the issue has already been discussed.  Otherwise, send an
  96 email to @email{lilypond-devel@@gnu.org}.  You can subscribe to
  97 the developers' mailing list here:
  98 @uref{http://lists.gnu.org/mailman/listinfo/lilypond-devel}.
  99
 100 @warning{Contributors on Windows or MacOS X wishing to compile
 101 code or documentation are strongly advised to use @ref{Lilybuntu}
 102 instead of trying to install all software dependencies
 103 themselves.}
 104
 105
 106 @node Lilybuntu
 107 @section Lilybuntu
 108
 109 It is not possible to compile LilyPond on Windows, and extremely
 110 difficulty to compile it on MacOS X.  We have therefore made a
 111 @q{remix} of Ubuntu which includes all necessary dependencies to
 112 compile both LilyPond and the documentation.  This can be run
 113 inside a virtual machine without disturbing your main operating
 114 system.
 115
 116 @enumerate
 117 @item
 118 Install some virtualization software.
 119
 120 Any virtualization tool can be used, but we recommend VirtualBox
 121 Open Source Edition (lower half of the linked page):
 122
 123 @example
 124 @uref{http://@/www.virtualbox.org/@/wiki/@/Downloads}
 125 @end example
 126
 127 In virtualization terminology, your main operating system is the
 128 @qq{host}.
 129
 130 @item
 131 Download the @file{lilybuntu.iso} disk image.
 132
 133 @example
 134 @uref{http://@/files.lilynet.net/@/lilybuntu.iso}
 135 @end example
 136
 137 @item
 138 Install @file{lilybuntu.iso} as the @qq{client} operating system
 139 on your virtualized system.
 140
 141 The latest version of lilybuntu is based on Ubuntu 9.04; if you
 142 encounter any difficulties installing it, search for one of the
 143 many tutorials for installing Ubuntu 9.04 as a client operating
 144 system.
 145
 146 If possible, use at least 700 MB of RAM (1GB would be better) for
 147 the virtual machine, and use a dynamically expanding virtual hard
 148 drive.  A complete compile of everything (code, docs, regression
 149 tests) can reach 10 GB.
 150
 151 @item
 152 Do any extra configuration for your virtualization software.
 153
 154 VirtualBox has extra @qq{guest additions} which can make the
 155 virtualization easier to use (full-screen, easy file sharing
 156 between host and client operating systems, shared clipboards,
 157 etc).  Follow the normal procedures for your virtualization
 158 software with Ubuntu 9.04 as the client.
 159
 160 @end enumerate
 161
 162 Follow instructions for Linux when reading instructions about
 163 @ref{Working with source code}, or @ref{Compiling}.
 164
 165
 166 @node Mentors
 167 @section Mentors
 168
 169 We have a semi-formal system of mentorship, similar to the
 170 medieval @qq{journeyman/master} training system.  New contributors
 171 will have a dedicated mentor to help them @qq{learn the ropes}.
 172
 173 @warning{This is subject to the availability of mentors; certain
 174 jobs have more potential mentors than others.}
 175
 176 @subheading Contributor responsibilities
 177
 178 @enumerate
 179
 180 @item
 181 Ask your mentor which sections of the CG you should read.
 182
 183 @item
 184 If you get stuck for longer than 10 minutes, ask your mentor.
 185 They might not be able to help you with all problems, but we find
 186 that new contributors often get stuck with something that could be
 187 solved/explained with 2 or 3 sentences from a mentor.
 188
 189 @item
 190 Send patches to your mentor for initial comments.
 191
 192 @item
 193 Inform your mentor if you're going to be away for a month, or if
 194 you leave entirely.  Contributing to lilypond isn't for everybody;
 195 just let your mentor know so that we can reassign that work to
 196 somebody else.
 197
 198 @item
 199 Inform your mentor if you're willing to do more work -- we always
 200 have way more work than we have helpers available.  We try to
 201 avoid overwhelming new contributors, so you'll be given less work
 202 than we think you can handle.
 203
 204 @end enumerate
 205
 206
 207 @subheading Mentor responsibilities
 208
 209 @enumerate
 210
 211 @item
 212 Respond to questions from your contributor(s) promptly, even if
 213 the response is just @qq{sorry, I don't know} or @qq{sorry, I'm
 214 very busy for the next 3 days; I'll get back to you then}.  Make
 215 sure they feel valued.
 216
 217 @item
 218 Inform your contributor(s) about the expected turnaround for your
 219 emails -- do you work on lilypond every day, or every weekend, or
 220 what?  Also, if you'll be unavailable for longer than usual (say,
 221 if you normally reply within 24 hours, but you'll be at a
 222 conference for a week), let your contributors know.  Again, make
 223 sure they feel valued, and that your silence (if they ask a
 224 question during that period) isn't their fault.
 225
 226 @item
 227 Inform your contributor(s) if they need to do anything unusual for
 228 the builds, such as doing a @qq{make clean / doc-clean} or
 229 switching git branches (not expected, but just in case...)
 230
 231 @item
 232 You don't need to be able to completely approve patches.  Make
 233 sure the patch meets whatever you know of the guidelines (for doc
 234 style, code indentation, whatever), and then send it on to the
 235 frog list or -devel for more comments.  If you feel confident
 236 about the patch, you can push it directly (this is mainly intended
 237 for docs and translations; code patches should almost always go to
 238 -devel before being pushed).
 239
 240 @item
 241 Keep track of patches from your contributor.  If you've sent a
 242 patch to -devel, it's your responsibility to pester people to get
 243 comments for it, or at very least add it to the google tracker.
 244
 245 @end enumerate
 246
 247