[development] Suggestion for people releasing new modules and themes into CVS

Syscrusher syscrusher at 4th.com
Wed Sep 13 14:10:17 UTC 2006


Good morning, all!

I have a small and simple suggestion for people releasing a new module or theme
for Drupal:

When you do your initial commit into CVS, be a bit more verbose in the CVS commit
log comments. These get reproduced onto the CVS notification list. It would be
handy for the rest of us to know what spiffy new module or theme you've released,
rather than just its name.

For instance, if you release "foo" module, instead of:

     Added "foo" module to CVS HEAD

which just states the obvious, how about:

     Added "foo", a new module that allows a Drupal site to automatically
     accept new tweedle glomping requests via XML-RPC from sites like
     www.example.com that support the "FooBar" document standard. "foo"
     is feature-complete but still needs some cosmetic cleanup.

I know we can all go out and look at the module listing pages on drupal.org, but
if you make that first CVS commit more of an announcement, you might generate
interest in your new module from other contributors who don't always have the
time to go read the module page every time a new module is contributed. :-)
There may also be developers of related modules who'd like to combine efforts
with you.

Alternatively, a note posted to the Development list would be fine, too. The
main point is to remember that the module or theme name may not provide much
info on what it does, especially for those who aren't familiar with whatever
previous work inspired the name. (E.g., if you don't know what Deli.cio.us
does, you might think a module by that name is for recipes or restaurant
listings, etc.)

Thanks for considering this suggestion.

Scott

-- 
-------------------------------------------------------------------------------
Syscrusher (Scott Courtney)          Drupal page:   http://drupal.org/user/9184
syscrusher at 4th dot com            Home page:     http://4th.com/   


More information about the development mailing list