|
|
Python Patch Submission Guidelines
We're using the SourceForge Patch Manager. Here are the main
guidelines:
- Submit your patch to the patch manager
interface at SourceForge. We strongly recommend that you register with
SourceForge before submitting a patch. The patch manager is for
patches only; if you have a problem or suggestion but don't
know how to write the code for it, use the bugs manager
instead.
- Submit documentation patches the same way. When adding the
patch, be sure to set the "Category" field to
"documentation". For documentation errors without patches,
please use the bugs manager instead.
- We like context diffs. We grudgingly accept unified diffs.
Straight ("ed-style") diffs are right out! If you don't know
how to generate context diffs, you're probably not qualified to
produce high-quality patches anyway <0.5 wink>.
- We appreciate it if you send patches relative to the current CVS
tree. These are our latest sources. Even a patch relative to the
latest alpha or beta release may be way out of date.
- Please add a succinct message to your SourceForge entry that
explains what the patch is about that we can use directly as a checkin
message. Ideally, such a message explains the problem and describes
the fix in a few lines.
- For patches that add or change functionality: please also update
the documentation and the testcases (the Lib/test
subdirectory). For new modules, we appreciate a new test module
(typically test/test_spam.py). In this case, there's no need to mail
the documentation to a different address (in fact, in order to verify
that the bundle is complete, it's easier to mail everything together).
- There are a variety of additional style
requirements. Please have a look at these before writing new
code. Also have a look at the general Python Style Guide.
|