Added a 'contributing' page to the philo docs. This is meant primarily as an initial...
authorStephen Burrows <stephen.r.burrows@gmail.com>
Wed, 20 Jul 2011 03:40:59 +0000 (23:40 -0400)
committerStephen Burrows <stephen.r.burrows@gmail.com>
Wed, 20 Jul 2011 03:40:59 +0000 (23:40 -0400)
README
README.markdown
docs/contributing.rst [new file with mode: 0644]
docs/index.rst

diff --git a/README b/README
index dbd9cc2..6fa1548 100644 (file)
--- a/README
+++ b/README
@@ -8,10 +8,6 @@ Prerequisites:
        * (Optional) south 0.7.2+ <http://south.aeracode.org/>
        * (Optional) recaptcha-django r6 <http://code.google.com/p/recaptcha-django/>
 
        * (Optional) south 0.7.2+ <http://south.aeracode.org/>
        * (Optional) recaptcha-django r6 <http://code.google.com/p/recaptcha-django/>
 
-To contribute, please visit the project website <http://project.philocms.org/> and/or make a fork of the git repository on GitHub <http://github.com/ithinksw/philo> or Gitorious <http://gitorious
-.org/ithinksw/philo>. Feel free to join us on IRC at irc://irc.oftc.net/#philo.
-
-
 ====
 Using philo
 ====
 ====
 Using philo
 ====
@@ -22,4 +18,4 @@ After installing philo and mptt on your python path, make sure to complete the f
 3. include 'philo.urls' somewhere in your urls.py file.
 4. Optionally add a root node to your current Site.
 
 3. include 'philo.urls' somewhere in your urls.py file.
 4. Optionally add a root node to your current Site.
 
-Philo should be ready to go!
+Philo should be ready to go! All that's left is to learn more <http://philo.readthedocs.org> and contribute <http://philo.readthedocs.org/en/latest/contribute.html>.
index 91a8115..5f90ba6 100644 (file)
@@ -22,4 +22,4 @@ After installing philo and mptt on your python path, make sure to complete the f
 3. include 'philo.urls' somewhere in your urls.py file.
 4. Optionally add a root node to your current Site.
 
 3. include 'philo.urls' somewhere in your urls.py file.
 4. Optionally add a root node to your current Site.
 
-Philo should be ready to go!
+Philo should be ready to go! All that's left is to [learn more](http://philo.readthedocs.org) and [contribute](http://philo.readthedocs.org/en/latest/contribute.html).
diff --git a/docs/contributing.rst b/docs/contributing.rst
new file mode 100644 (file)
index 0000000..9354c72
--- /dev/null
@@ -0,0 +1,8 @@
+Contributing to Philo
+=====================
+
+So you want to contribute to Philo? That's great! Here's some ways you can get started:
+
+* **Report bugs and request features.** :mod:`philo` uses a Redmine installation located at `http://ithinksw.org/projects/philo/issues <http://ithinksw.org/projects/philo/issues>`_ for issue tracking. In order to report an issue, you will need to register for an account with the tracker.
+* **Contribute code.** Philo uses git to manage its code. You can fork philo's repository either on `GitHub <http://github.com/ithinksw/philo>`_ or `Gitorious <http://gitorious.org/ithinksw/philo>`_. If you are contributing to Philo, you may need to submit a `Contributor License Agreement <http://en.wikipedia.org/wiki/Contributor_License_Agreement>`_.
+* **Join the discussion** on IRC at `irc://irc.oftc.net/#philo <irc://irc.oftc.net/#philo>`_ if you have any questions or suggestions or just want to chat about the project. You can also keep in touch via :mod:`philo`'s mailing lists: `philo@ithinksw.org <mailto:philo@ithinksw.org>`_ and `philo-devel@ithinksw.org <mailto:philo-devel@ithinksw.org>`_.
index 7e960a0..743fa39 100644 (file)
@@ -19,8 +19,6 @@ Prerequisites:
 * (Optional) `south 0.7.2+ <http://south.aeracode.org/>`_
 * (Optional) `recaptcha-django r6 <http://code.google.com/p/recaptcha-django/>`_
 
 * (Optional) `south 0.7.2+ <http://south.aeracode.org/>`_
 * (Optional) `recaptcha-django r6 <http://code.google.com/p/recaptcha-django/>`_
 
-To contribute, please visit the `project website <http://project.philocms.org/>`_ and/or make a fork of the git repository on `GitHub <http://github.com/ithinksw/philo>`_ or `Gitorious <http://gitorious.org/ithinksw/philo>`_. Feel free to join us on IRC at `irc://irc.oftc.net/#philo <irc://irc.oftc.net/#philo>`_.
-
 Contents
 ++++++++
 
 Contents
 ++++++++
 
@@ -39,6 +37,7 @@ Contents
        forms
        loaders
        contrib/intro
        forms
        loaders
        contrib/intro
+       contributing
 
 Indices and tables
 ++++++++++++++++++
 
 Indices and tables
 ++++++++++++++++++