Wednesday, February 8, 2012

Re: How to submit tests and docs while submitting patches

On Feb 8, 1:06 pm, Karthik Abinav <karthikabin...@gmail.com> wrote:
> Hi,
>
>  I would like to contribute to django. But I am not clear as to how to
> submit the tests and docs while submitting my patches. Or does every patch
> need a tests and docs. Help would be appreciated.

In general, new features need documentation and all patches need tests
if at all possible. There are some cases where writing a test is
exceptionally hard (for example, testing the test runner), and that
might be a good reason to skip the tests part.

Optimally you should include code, documentation and tests in a single
patch. You can find the tests from the tests subdirectory,
documentation from doc subdirectory. For first-time contributor
knowing where you should put your tests and what documentation to
write can be a challenge. It is OK to first submit just the code
portion of the patch. When posting the patch into trac, just say that
you are unsure of what tests/documentation is needed. Reviewers will
usually help you out from there.

- Anssi

--
You received this message because you are subscribed to the Google Groups "Django users" group.
To post to this group, send email to django-users@googlegroups.com.
To unsubscribe from this group, send email to django-users+unsubscribe@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/django-users?hl=en.

No comments:

Post a Comment