Author: julien
Date: 2011-08-25 19:43:33 -0700 (Thu, 25 Aug 2011)
New Revision: 16688
Modified:
django/trunk/docs/internals/contributing/writing-code/coding-style.txt
django/trunk/docs/internals/contributing/writing-code/submitting-patches.txt
Log:
Added some tips to the contributor docs, namely about removing trailing
whitespaces and about mentioning relevant ticket numbers in tests.
Modified: django/trunk/docs/internals/contributing/writing-code/coding-style.txt
===================================================================
--- django/trunk/docs/internals/contributing/writing-code/coding-style.txt
2011-08-25 23:02:15 UTC (rev 16687)
+++ django/trunk/docs/internals/contributing/writing-code/coding-style.txt
2011-08-26 02:43:33 UTC (rev 16688)
@@ -184,6 +184,12 @@
* 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
Modified:
django/trunk/docs/internals/contributing/writing-code/submitting-patches.txt
===================================================================
---
django/trunk/docs/internals/contributing/writing-code/submitting-patches.txt
2011-08-25 23:02:15 UTC (rev 16687)
+++
django/trunk/docs/internals/contributing/writing-code/submitting-patches.txt
2011-08-26 02:43:33 UTC (rev 16688)
@@ -101,8 +101,11 @@
* The code required to fix a problem or add a feature is an essential part
of a patch, but it is not the only part. A good patch should also
- include a regression test to validate the behavior that has been fixed,
- to prevent the problem from arising again.
+ include a regression test to validate the behavior that has been fixed
+ and to prevent the problem from arising again. Also, if some tickets are
+ relevant to the code that you've written, mention the ticket numbers in
+ some comments in the test so that one can easily trace back the relevant
+ discussions after your patch gets committed and the tickets get closed.
* If the code associated with a patch adds a new feature, or modifies
behavior of an existing feature, the patch should also contain
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
