User login

Home ›
 Patch naming conventions for Drupal core and contrib

Patch naming conventions for Drupal core and contrib

Submitted by Benjamin Melançon on September 13, 2008 - 1:59pm
in
Searched words: 
Naming standards for Drupal code patches

webchick talking to Michelle in IRC #drupal:

I name all my patches as {module_name}-{description-of-changes}-{issue_node_id}-{issue_comment_id}.patch

Personally, I think issue_comment_id might be hard to do (even interpreted as the big #5 etc project module places in the comment title, rather than the internal Drupal ID!) since people can add comments while you are making the patch, but I'm on board with the ideal.

Getting into that habit also really forces you to keep to a one-issue-one-change thing.

It's like she knows I'm listening!

Resolution

Comments

Drupal handbook page

Submitted by rooby (not verified) on November 2, 2010 - 7:22pm.

There is a drupal.org handbook page that has this information too.

It's at http://drupal.org/patch/submit

In regards to the comment ID part, if you are in the habit of previewing your comments before posting you will avoid this most of the time as the preview will have your comment number and you can quickly rename if necessary. So it would then only be an issue very rarely when a person posts only between the time you preview and submit.

Post new comment

The content of this field is kept private and will not be shown publicly.
  • Internal paths in single or double quotes, written as "internal:node/99", for example, are replaced with the appropriate absolute URL or path. Paths to files in single or double quotes, written as "files:somefile.ext", for example, are replaced with the appropriate URL that can be used to download the file.
  • You may post code using <code>...</code> (generic) or <?php ... ?> (highlighted PHP) tags.
  • You can use Markdown syntax to format and style the text. Also see Markdown Extra for tables, footnotes, and more.
  • Web page addresses and e-mail addresses turn into links automatically.
  • Allowed HTML tags: <a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd> <img> <blockquote> <small> <h2> <h3> <h4> <h5> <h6> <sub> <sup> <p> <br> <strike> <table> <tr> <td> <thead> <th> <tbody> <tt> <output>
  • Syntax highlight code surrounded by the {syntaxhighlighter SPEC}...{/syntaxhighlighter} tags, where SPEC is a Syntaxhighlighter options string or "class="OPTIONS" title="the title".
  • Lines and paragraphs break automatically.

More information about formatting options

By submitting this form, you accept the Mollom privacy policy.