From 0d1edc645059177bf3b9bad6aefa0792e7804edd Mon Sep 17 00:00:00 2001 From: Alexis Metaireau Date: Tue, 10 May 2011 23:41:27 +0100 Subject: [PATCH] Add some informations about how to contribute. This would need a more precise description and some good practices to follow. --- docs/contribute.rst | 13 +++++++++++++ docs/index.rst | 1 + 2 files changed, 14 insertions(+) create mode 100644 docs/contribute.rst diff --git a/docs/contribute.rst b/docs/contribute.rst new file mode 100644 index 00000000..74e67a72 --- /dev/null +++ b/docs/contribute.rst @@ -0,0 +1,13 @@ +How to contribute ? +=================== + +There are features missing from pelican and you now exactly how to implement +them? That's great! Don't hesitate to fork and make a pull request on github. + +Running the test suite +---------------------- + +It would even be better if you could add tests for this feature. The tests +are located under "pelican/tests" and you will need unittests2 to run them:: + + python -m unittest2 discover diff --git a/docs/index.rst b/docs/index.rst index a370a94f..39f3d599 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -52,3 +52,4 @@ A french version of the documentation is available at :doc:`fr/index`. themes internals faq + contribute