From 5eeb2d56d50dc7b280cd11267add8cf2da5f26a3 Mon Sep 17 00:00:00 2001 From: Julien Phalip Date: Fri, 26 Aug 2011 02:43:33 +0000 Subject: Added some tips to the contributor docs, namely about removing trailing whitespaces and about mentioning relevant ticket numbers in tests. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16688 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/internals/contributing/writing-code/coding-style.txt | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/internals/contributing/writing-code/coding-style.txt') diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt index 7a07735616..34eef100c7 100644 --- a/docs/internals/contributing/writing-code/coding-style.txt +++ b/docs/internals/contributing/writing-code/coding-style.txt @@ -184,6 +184,12 @@ Miscellaneous * Remove ``import`` statements that are no longer used when you change code. The most common tools for this task are `pyflakes`_ and `pylint`_. + * Systematically remove all trailing whitespaces from your code as those + add unnecessary bytes, add visual clutter to the patches and can also + occasionally cause unnecessary merge conflicts. Some IDE's can be + configured to automatically remove them and most VCS tools can be set to + highlight them in diff outputs. + * Please don't put your name in the code you contribute. Our policy is to keep contributors' names in the ``AUTHORS`` file distributed with Django -- not scattered throughout the codebase itself. Feel free to include a -- cgit v1.3