docs/contributinghowto.rst

   1 .. _contributing-howto-chapter:
   2
   3 ====================
   4  Contributing HOWTO
   5 ====================
   6
   7 .. _join-the-community-section:
   8
   9 Join the community!
  10 ===================
  11
  12 We're super glad you want to join our community!
  13
  14 See `the join page on the website <http://mediagoblin.org/join/>`_ for
  15 where we hang out.
  16
  17 There are a variety of ways you can help us and become part of the
  18 team.  We're not just looking for coders!  We're also looking for
  19 documentation writers, users, testers, evangelists, user-interface
  20 designers, graphics designers, user-experience designers, system
  21 administrators, friends, painters, bakers, candle-stick makers...
  22
  23 Here are some things you can do today:
  24
  25
  26     **Hang out with us**
  27
  28         You should hang out with us!  We like people like you!
  29
  30         At a bare minimum, join the `mailing list
  31         <http://mediagoblin.org/join/>`_ and say, "Hi!"
  32
  33         We also hang out on IRC in ``#mediagoblin`` on Freenode.net.
  34
  35
  36     **File bugs**
  37
  38         Filing bugs is a critical part of any project.  For more
  39         information on filing bugs, see :ref:`filing-bugs`.
  40
  41
  42     **Write/Fix some code**
  43
  44         If you are a coder and you're looking to code, check out the
  45         :ref:`hacking-howto`.  We even have tips on *becoming* a coder
  46         and we're willing to help you!
  47
  48
  49     **Send encouragement**
  50
  51         A nice word from you could send someone into a tizzy of
  52         productive work.  Ten nice words could complete a feature.
  53         One hundred nice words could get us to the next milestone.
  54
  55         Send it to the `mailing list <http://mediagoblin.org/join/>`_
  56         or hop into ``#mediagoblin`` on Freenode.net and let us know.
  57
  58
  59     **Spread the word**
  60
  61         The seductive call of Free Software services is a powerful
  62         one, but many cannot hear it because it's drowned out by the
  63         rush hour traffic honking of proprietary walled gardens and
  64         faux free services.  Yuck!  Be the sweet chirrup of the bird
  65         amidst the din!  Tell others that there is a better way to
  66         live!
  67
  68         FIXME - do we want to talk about ways to spread the word?
  69
  70         FIXME - how can people notify us that they're spreading the
  71         word?
  72
  73
  74 We're still working on project infrastructure.  We hope to have the
  75 bits in place for these additional things to do in the coming months:
  76
  77     **Become a user**
  78
  79         We're building GNU MediaGoblin for us and for you but really
  80         you're one of us and I am you and we are we and GNU
  81         MediaGoblin is the walrus.
  82
  83         Sign up for an account.  Use the service.  Relish in the
  84         thought that this service comes with a heaping side of Freedom
  85         and you can salt and pepper it to your liking.
  86
  87
  88     **Help other users**
  89
  90         Have you spent time with GNU MediaGoblin?  If so, your
  91         experience and wisdom are invaluable and you're the best
  92         person we can think of to help other users with their
  93         questions.
  94
  95
  96     **Run your own instance**
  97
  98         Are there things about our instance you want to change?  Are
  99         there things about other instances you wish were different?
 100         Want to test upcoming changes?  Want to create patches to
 101         implement things you need?  That's great---you can run your
 102         own instance!
 103
 104         For more information on deploying your own instance, see
 105         :ref:`deployment-howto`.
 106
 107
 108     **Translate GNU MediaGoblin**
 109
 110         Knowing more than one language is an important skill.  If you
 111         are multi-lingual and are interested in translating GNU
 112         MediaGoblin, see :ref:`translating`.
 113
 114
 115     **Create a theme**
 116
 117         As people deploy their own GNU MediaGoblin instances, good
 118         themes are a must have!  For more information on theming, see
 119         :ref:`theming-howto`.
 120
 121
 122 Contributing thank you drawings / copyright assignment
 123 ======================================================
 124
 125 Copyright assignment with GNU MediaGoblin to the `FSF
 126 <http://fsf.org>`_ is highly encouraged but not mandatory.  To
 127 incentivize both this and people to make cool contributions to our
 128 project, if you make useful contributions to GNU MediaGoblin *and* do
 129 a copyright assignment to the Free Software Foundation, the founder of
 130 the project, Chris Webber, will make a custom drawing of a goblin
 131 dedicated specifically to you.
 132
 133 For why we're doing copyright assignment, see the
 134 :ref:`design-decisions-chapter`.
 135
 136
 137 .. _filing-bugs:
 138
 139 File bugs
 140 =========
 141
 142 GNU MediaGoblin uses a bug tracker called `Redmine
 143 <http://www.redmine.org>`_.
 144
 145 The bug tracker is at `<http://bugs.foocorp.net/projects/mediagoblin>`_.
 146
 147 A good bug report has the following things in it:
 148
 149 1. A short summary that's 60 characters or less.
 150
 151 2. A description that describes the issue (bug, feature request, ...)
 152    as well as the context.
 153
 154   * If it's a bug, can you reproduce it?  Is the issue specific to a
 155     browser, computer, image, ...?
 156
 157   * If it's a feature request, are there related links on the Internet
 158     for more information?  Would you be willing to help implement or
 159     test the feature?
 160
 161 That's it!  When someone looks into the issue and has questions,
 162 they'll contact you!
 163
 164 If you don't hear from anyone in a couple of weeks, find someone on
 165 IRC.
 166
 167
 168 .. _translating:
 169
 170 Translate GNU MediaGoblin
 171 =========================
 172
 173 Coming soon when we set up translation infrastructure.
 174
 175
 176 Where to go when you get stuck
 177 ==============================
 178
 179 Go to `our Web site <http://mediagoblin.org/>`_ where we list the
 180 various places we hang out and how to get a hold of us.
 181