From c79bb6f20ff4100201f23a5d521aaa39dfc1c291 Mon Sep 17 00:00:00 2001 From: Stephen Burrows Date: Tue, 19 Jul 2011 23:40:59 -0400 Subject: [PATCH] Added a 'contributing' page to the philo docs. This is meant primarily as an initial effort, which can be expanded upon more later. --- README | 6 +----- README.markdown | 2 +- docs/contributing.rst | 8 ++++++++ docs/index.rst | 3 +-- 4 files changed, 11 insertions(+), 8 deletions(-) create mode 100644 docs/contributing.rst diff --git a/README b/README index dbd9cc2..6fa1548 100644 --- a/README +++ b/README @@ -8,10 +8,6 @@ Prerequisites: * (Optional) south 0.7.2+ * (Optional) recaptcha-django r6 -To contribute, please visit the project website and/or make a fork of the git repository on GitHub or Gitorious . Feel free to join us on IRC at irc://irc.oftc.net/#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. -Philo should be ready to go! +Philo should be ready to go! All that's left is to learn more and contribute . diff --git a/README.markdown b/README.markdown index 91a8115..5f90ba6 100644 --- a/README.markdown +++ b/README.markdown @@ -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. -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 index 0000000..9354c72 --- /dev/null +++ b/docs/contributing.rst @@ -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 `_ 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 `_ or `Gitorious `_. If you are contributing to Philo, you may need to submit a `Contributor License Agreement `_. +* **Join the discussion** on IRC at `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 `_ and `philo-devel@ithinksw.org `_. diff --git a/docs/index.rst b/docs/index.rst index 7e960a0..743fa39 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,8 +19,6 @@ Prerequisites: * (Optional) `south 0.7.2+ `_ * (Optional) `recaptcha-django r6 `_ -To contribute, please visit the `project website `_ and/or make a fork of the git repository on `GitHub `_ or `Gitorious `_. Feel free to join us on IRC at `irc://irc.oftc.net/#philo `_. - Contents ++++++++ @@ -39,6 +37,7 @@ Contents forms loaders contrib/intro + contributing Indices and tables ++++++++++++++++++ -- 2.20.1