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