Permalink
Browse files

First pass at better contributor docs

* fixed some typos
* add hacking howto, contact us, and contributor docs
* added an AUTHORS file

The hacking howto probably doesn't work, but it's close. It needs someone
to go through it and fix issues in the docs and in the code to make it
work better.
  • Loading branch information...
1 parent aadb5b2 commit e404c218a84e98c6ef9f8b17e4f9a7c602143fb2 @willkg willkg committed May 4, 2012
Showing with 432 additions and 1 deletion.
  1. +36 −0 AUTHORS
  2. +36 −0 docs/contactus.rst
  3. +61 −0 docs/contributors.rst
  4. +288 −0 docs/hacking_howto.rst
  5. +11 −1 docs/index.rst
View
36 AUTHORS
@@ -0,0 +1,36 @@
+=======
+AUTHORS
+=======
+
+Current primary developers:
+
+* James Socol (jsocol)
+* Ricky Rosario (r1cky)
+* Will Kahn-Greene (willkg)
+
+Contributors:
+
+* Alex Buchanan
+* atopal
+* Berker Peksag
+* Cheng Wang
+* Erik Rose
+* Fred Wenzel
+* Ibai
+* Isac Lagerblad
+* James Socol
+* Jason Thomas
+* Jeremy Orem
+* Joshua Gross
+* Paul Craciunoiu
+* Pragun Bhutani
+* Ricky Rosario
+* Shyam Mani
+* Stas
+* Tanay Gavankar
+* Tanner Filip
+* Tim Watts
+* Tobbi
+* Tomoya Asai
+* voodoochild
+* Will Kahn-Greene
View
@@ -0,0 +1,36 @@
+.. _contact-us-chapter:
+
+==========
+Contact us
+==========
+
+SUMO contributor forums
+=======================
+
+If you're a SUMO contributor, then consider using the `contributor
+forums <https://support.mozilla.org/en-US/forums>`_. This is the place
+for SUMO community discussions.
+
+
+Kitsune hackers
+===============
+
+If you're hacking on the Kitsune code and have questions, ping us on
+IRC.
+
+We hang out in ``#sumodev`` on irc.mozilla.org. We're usually around
+during the day in Eastern Time.
+
+If you ask something and all you get is silence, then it's probably
+the case that we're not around. Please try pinging us again.
+
+Current primary developers:
+
+.. comment::
+
+ This is a slight repeat from AUTHORS. We just need to point out
+ people to contact if someone is having problems.
+
+* James Socol (jsocol)
+* Ricky Rosario (r1cky)
+* Will Kahn-Greene (willkg)
View
@@ -0,0 +1,61 @@
+.. _contributors-chapter:
+
+==================
+Join this project!
+==================
+
+Kitsune is the software that runs `SUMO (support.mozilla.org)
+<http://support.mozilla.org/>`_ which provides support for Firefox and
+other Mozilla software.
+
+Interested in helping out? Here's a bunch of things we need your help
+with.
+
+
+Help with support!
+==================
+
+First off, you can help people get the most out of Firefox by joining
+the awesome support community. This community not only helps people
+with their Firefox issues, but is also the front line in helping drive
+Firefox development.
+
+For more information on this, see the `quickstart guide
+<https://support.mozilla.org/en-US/kb/superheroes-wanted>`_ on the
+SUMO site.
+
+
+Help with hacking!
+==================
+
+First step is to set up Kitsune so you can run it and hack on it. For
+that, see the :ref:`hacking-howto-chapter`.
+
+If you have problems, please let us know! See
+:ref:`contact-us-chapter`.
+
+After you've got it up and running, check out the list of bugs that
+are marked for mentoring:
+
+https://wiki.mozilla.org/Webdev/GetInvolved#support.mozilla.org_.28SUMO.29
+
+If you want to work on one of these bugs, contact the mentor listed in
+the whiteboard section.
+
+
+Help with making Kitsune easier for hacking on!
+===============================================
+
+We're working on making Kitsune easier to hack on. This entails:
+
+* reducing the steps it takes to get Kitsune running down to a smaller
+ minimal set
+* making this documentation better
+* providing better resources for people who are interested in helping
+ out
+* providing better scripts to automate installing and maintaining
+ Kitsune
+
+Any thoughts you have on making this easier are much
+appreciated. Further, if you could help us, that'd be valuable to us
+and all those who follow in your footsteps.
Oops, something went wrong.

0 comments on commit e404c21

Please sign in to comment.