heckyel/mediagoblin
0
0
Fork 0
Code Issues Pull Requests Releases Activity

Reworked contributing docs based on Asheesh's thoughts

Browse Source 
I chatted with Asheesh on IRC today and asked him to look over the
contributer howto.  He had a lot of thoughts and I factored most/all
of them in.  It's much better now.
This commit is contained in:
Will Kahn-Greene
2011-04-27 22:42:17 -04:00
parent 84489d7d4a
commit 9d952fdc79
5 changed files with 149 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
docs/contributinghowto.rst
View File

@@ -2,72 +2,104 @@
Contributing HOWTO
====================
We're super glad you want to contribute!
Join the community!
===================
We're super glad you want to join our community!
There are a variety of ways you can help us and become part of the
team. We're not just looking for coders! We're also looking for
documentation writers, users, testers, evangelists, painters, bakers,
candle-stick makers...
documentation writers, users, testers, evangelists, user-interface
designers, graphics designers, user-experience designers, system
administrators, friends, painters, bakers, candle-stick makers...
However, if you are a coder and you're looking to code, check out the
:ref:`hacking-howto`.
The rest of this chapter talks about different things we need your
help with.
Here are some things you can do today:
**Become a user**
**Hang out with us**
We're building GNU MediaGoblin for us and for you but really
you're one of us and I am you and we are we and GNU MediaGoblin is
the walrus.
You should hang out with us! We like people like you!
At a bare minimum, join the `mailing list
<http://mediagoblin.org/join/>`_ and say, "Hi!"
We also hang out on IRC in ``#mediagoblin`` on Freenode.net.
**File bugs**
Filing bugs is a critical part of any project. For more
information on filing bugs, see :ref:`filing-bugs`.
**Write/Fix some code**
If you are a coder and you're looking to code, check out the
:ref:`hacking-howto`. We even have tips on *becoming* a coder
and we're willing to help you!
**Run your own instance**
Are there things about our instance you want to change? Are
there things about other instances you wish were different?
Want to test upcoming changes? Want to create patches to
implement things you need? That's great---you can run your
own instance!
Sign up for an account. Use the service. Relish in the thought
that this service comes with a heaping side of Freedom and you can
salt and pepper it to your liking.
For more information on deploying your own instance, see
:ref:`deployment-howto`.
**File bugs**
**Spread the word**
Filing bugs is a critical part of any project. For more
information on filing bugs, see :ref:`filing-bugs`.
The seductive call of Free Software services is a powerful
one, but many cannot hear it because it'd drowned out by the
rush hour traffic honking of proprietary walled gardens and
faux free services. Yuck! Be the sweet chirrup of the bird
amidst the din! Tell others that there is a better way to
live!
FIXME - do we want to talk about ways to spread the word?
FIXME - how can people notify us that they're spreading the
word?
**Translate GNU MediaGoblin**
We're still working on project infrastructure. We hope to have the
bits in place for these additional things to do in the coming months:
Knowing more than one language is an important skill. If you are
multi-lingual and are interested in translating GNU MediaGoblin,
see :ref:`translating`.
**Become a user**
**Create a theme**
As people deploy their own GNU MediaGoblin instances, good themes
are a must have! For more information on theming, see
:ref:`theming-howto`.
**Spread the word**
The seductive call of Free Software services is a powerful one,
but many cannot hear it because it'd drowned out by the rush hour
traffic honking of proprietary walled gardens and faux free
services. Yuck! Be the sweet chirrup of the bird amidst the din!
Tell others that there is a better way to live!
FIXME - do we want to talk about ways to spread the word?
FIXME - how can people notify us that they're spreading the word?
**Run your own instance**
Are there things about our instance you want to change? Are there
things about other instances you wish were different? That's
great---you can run your own instance!
We're building GNU MediaGoblin for us and for you but really
you're one of us and I am you and we are we and GNU
MediaGoblin is the walrus.
For more information on deploying your own instance, see
:ref:`deployment-howto`.
Sign up for an account. Use the service. Relish in the
thought that this service comes with a heaping side of Freedom
and you can salt and pepper it to your liking.
**Help other users**
Have you spent time with GNU MediaGoblin? If so, your
experience and wisdom are invaluable and you're the best
person we can think of to help other users with their
questions.
**Translate GNU MediaGoblin**
Knowing more than one language is an important skill. If you
are multi-lingual and are interested in translating GNU
MediaGoblin, see :ref:`translating`.
**Create a theme**
As people deploy their own GNU MediaGoblin instances, good
themes are a must have! For more information on theming, see
:ref:`theming-howto`.
Contributing thank you drawings / copyright assignment
@@ -93,8 +125,7 @@ File bugs
GNU MediaGoblin uses a bug tracker called `Redmine
<http://www.redmine.org>`_.
The bug tracker is at http://bugs.foocorp.net/ and bugs go in the
``GNU mediagoblin`` project.
The bug tracker is at `<http://bugs.foocorp.net/projects/mediagoblin>`_.
A good bug report has the following things in it: