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

Khalid B kb at 2bits.com
Thu Sep 14 03:15:19 UTC 2006


Here is the updated list based on the comments above:

- Upon committing a new module or theme, add a concise description of
what the module does or how this theme is unique (e.g. fluid/fixed, tables/css,
...etc.)

- Try to group your commits functionally. For example a change that affects
several files has to be committed in a single commit. This allows others to
know what has changed, roll it back if necessary, create patches, ...etc.
Do not commit unrelated changes together in one commit, and do not commit
the change to each file separately.

- Do not commit every file separately when initially committing a module.
Do a cvs add on all the files that need to go in, then do a cvs commit to
check them into the repository.

- If you are using a GUI client, check its default settings. For example
Eclipse uses -kk which affects the CVS Id tag. Change that to -kkv.

- Use the format following format for commits that relate to an issue:

#nodeid description-goes-here, by patch-contributor
On Drupal.org, the commits will be automatically linked to the issue.

- Do not post the entire URL of the issue on Drupal.org.

- It is important to provide a reference to the issue on Drupal.org, if one
exists. If you use #nid (where nid is the node Id of the issue in Drupal), then
it will be converted automatically to a hyperlink to http://drupal.org/node/nid.
This gets published at http://drupal.org/cvs.

- Drupal.org user names will be converted to links.

- A good convention to use is:
#nodeid description-goes-here, by patch-contributor

- If you are referencing another module or a 3rd party site in your
description, it is best if you provide a proper link to it, not just
a bare URL, or worse, just the name.


More information about the development mailing list