This is related to the changes that are also happening to the the Creating Patches page (see that issue here: http://drupal.org/node/133297). Creation stuff is being moved out so this page is only about the submission process. Again, first draft, so feedback is encouraged.

*****************************************

Coding style and Security

If your code deviates too much from the Coding standards, it is more likely to be rejected without further review and without comment. You may want to check your code with the Coder module to help you find style errors. Make sure your code is secure as well. Obviously code that introduces security issues will be rejected.

Describe your changes

Describe the technical detail of the change(s) your patch includes and try to be as specific as possible. Note that we prefer technical reasoning above marketing: give us clear reasons why "this way" is good. Justify your changes with solid reasoning. It is important to note the version to which this patch applies. To help people test your patch (vs. reviewing the code itself) you should also provide some basic instructions about what problems to look for or specific steps to take to see the effect of the patch in a test site.

Verify your patch

Reviewers are overloaded reviewing and testing patch submissions. Please make their lives easier by assuring the following:

  • Your code works! Test your code.
  • If your patch is just a quick hack, then don't set your issue to Patch (code needs review) status, instead set it to Active or Patch (code needs work).
  • For core Drupal, patch against HEAD. If the patch is accepted into HEAD it can then be ported back to specific versions. For contributed projects, you should patch against the latest development version (which may or may not be HEAD - check with the project).

Submit your patch

Patches should be submitted via the issue tracker. Create a bug report or feature request, attach your patch using the file upload form and set the issue's status to patch (code needs review) or patch (code needs work). Setting the status to patch is important as it adds the patch to the patch queue.

CommentFileSizeAuthor
#1 submittingPatches_rewrite.txt2.4 KBadd1sun

Comments

add1sun’s picture

StatusFileSize
new2.4 KB

Added a little bit at the beginning and cleaned a few things up.

dww’s picture

looks good. a few (possible) additions:

  1. the issue tracker does not except .zip .tar.gz or .tgz files -- attach a patch, not a package of all of your patched files (i only mention it since this comes up in real life).
  2. re: backporting your patch -- if it's definitely a core bug, you can help speed things along by attaching backported versions as separate follow-ups, each one with a version-specific port of your patch. you can only attach a single file to each issue reply, so to attach the HEAD, DRUPAL-5, and DRUPAL-4-7 versions of your fix, you'd need 3 replies...
  3. again, your "if it deviates too much it's likely to be..." stuff is too loose. ;) just say something like: "if the patch doesn't following the coding guidelines, it won't be accepted, so save yourself and everyone else time by making sure your patch adheres to the conventions before you even submit it."

otherwise, this is great. thanks!

add1sun’s picture

Status: Needs review » Fixed

This has been done now.

Anonymous’s picture

Status: Fixed » Closed (fixed)