From 3a9cb569d806745ef4a9b612d4dc638ecb209080 Mon Sep 17 00:00:00 2001 From: Neal Todd Date: Tue, 8 Jul 2014 13:16:55 +0100 Subject: [PATCH] Python 2/3 code contribution docs. --- README.rst | 3 ++- docs/contributing.rst | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index f0dc14abf2..83dc25f9d2 100644 --- a/README.rst +++ b/README.rst @@ -55,7 +55,8 @@ Contributing ~~~~~~~~~~~~ If you're a Python or Django developer, fork the repo and get stuck in! -We suggest you start by checking the `Help develop me! `_ label. +We suggest you start by checking the `Help develop me! `_ label, and the `coding guidelines `_. Send us a useful pull request and we'll post you a `t-shirt `_. +We also welcome `translations `_ for Wagtail's interface. diff --git a/docs/contributing.rst b/docs/contributing.rst index f5eb168b2c..40f88ccd5e 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -15,6 +15,7 @@ Coding guidelines ~~~~~~~~~~~~~~~~~ * PEP8. We ask that all Python contributions adhere to the `PEP8 `_ style guide, apart from the restriction on line length (E501). The `pep8 tool `_ makes it easy to check your code, e.g. ``pep8 --ignore=E501 your_file.py``. +* Python 2 and 3 compatibility. All Python contributions should support python 2 and 3 and recommend using the `six `_ compatibility library (use the pip version installed as a dependency, not the version bundled with Django). * Tests. Wagtail has a suite of tests, which we are committed to improving and expanding. We run continuous integration at `travis-ci.org/torchbox/wagtail `_ to ensure that no commits or pull requests introduce test failures. If your contributions add functionality to Wagtail, please include the additional tests to cover it; if your contributions alter existing functionality, please update the relevant tests accordingly. Styleguide