descrptive initial commit message, please
when you commit a new module/theme, please write what it does in the initial commit message. thats a whole lot more useful than 'Adding history module', for example. thanks.
On 13-Nov-06, at 12:39 PM, Moshe Weitzman wrote:
when you commit a new module/theme, please write what it does in the initial commit message. thats a whole lot more useful than 'Adding history module', for example.
thanks.
Good stuff, Moshe. I've updated the Maintainer quick-start guide to recommend this: http://drupal.org/handbook/cvs/quickstart Before it was recommending "Adding X module." so this is likely my fault. Sorry! -Angie
What really annoys me is contributors who commit every file in a separate commit, with no message at all. So, they have five or so files added, or modified, and you get five messages in the RSS feed, with no description whatsoever. I think a new term is CVS RSS Feed spam ... I do not know if this a misconfigured CVS front end or what. I tried to create a page on CVS hints and tips to address that, as well as putting in what Moshe recommended (describe the module), but it is not helping.
On 13 Nov 2006, at 18:59, Angela Byron wrote:
when you commit a new module/theme, please write what it does in the initial commit message. thats a whole lot more useful than 'Adding history module', for example.
Good stuff, Moshe.
I've updated the Maintainer quick-start guide to recommend this: http://drupal.org/handbook/cvs/quickstart
Before it was recommending "Adding X module." so this is likely my fault. Sorry!
Better yet, _always_ write descriptive commit messages. At all times, keep in mind that people are tracking your projects by reading your commit messages -- either on the website, in their RSS feeds, or by e-mail. Simply put: the quality of your commit messages determines how people perceive you and your projects ... -- Dries Buytaert :: http://www.buytaert.net/
On 14-Nov-06, at 2:37 AM, Dries Buytaert wrote:
On 13 Nov 2006, at 18:59, Angela Byron wrote:
when you commit a new module/theme, please write what it does in the initial commit message. thats a whole lot more useful than 'Adding history module', for example.
Good stuff, Moshe.
I've updated the Maintainer quick-start guide to recommend this: http://drupal.org/handbook/cvs/quickstart
Before it was recommending "Adding X module." so this is likely my fault. Sorry!
Better yet, _always_ write descriptive commit messages. At all times, keep in mind that people are tracking your projects by reading your commit messages -- either on the website, in their RSS feeds, or by e-mail. Simply put: the quality of your commit messages determines how people perceive you and your projects ...
Absolutely! I'm sure I've probably been guilty of this in the past, but having meaningful, well written commit messages is incredibly helpful. Also, as a reminder, if you use the syntax #XXXX (where XXXX is the nid of the issue your commit closes/resolves) that will automatically be linked by project.module back to the original issue thread. Please remember to use this where applicable. -- James Walker :: http://walkah.net/ :: xmpp:walkah@walkah.net
On Thu, 2006-11-16 at 18:35 -0500, James Walker wrote:
On 14-Nov-06, at 2:37 AM, Dries Buytaert wrote:
On 13 Nov 2006, at 18:59, Angela Byron wrote:
when you commit a new module/theme, please write what it does in the initial commit message. thats a whole lot more useful than 'Adding history module', for example.
Good stuff, Moshe.
I've updated the Maintainer quick-start guide to recommend this: http://drupal.org/handbook/cvs/quickstart
Before it was recommending "Adding X module." so this is likely my fault. Sorry!
Better yet, _always_ write descriptive commit messages. At all times, keep in mind that people are tracking your projects by reading your commit messages -- either on the website, in their RSS feeds, or by e-mail. Simply put: the quality of your commit messages determines how people perceive you and your projects ...
Absolutely! I'm sure I've probably been guilty of this in the past, but having meaningful, well written commit messages is incredibly helpful.
Also, as a reminder, if you use the syntax #XXXX (where XXXX is the nid of the issue your commit closes/resolves) that will automatically be linked by project.module back to the original issue thread. Please remember to use this where applicable.
-- James Walker :: http://walkah.net/ :: xmpp:walkah@walkah.net
so i'd look around line 625 of cvs.module of I wanted to add a %uid or %username?
On Nov 16, 2006, at 3:53 PM, Darrel O'Pry wrote:
so i'd look around line 625 of cvs.module of I wanted to add a %uid or %username?
sort of. you've got the right function but the wrong branch. ;) drupal.org is running DRUPAL-4-7--2 branch of cvs.module and project*.module. so, yeah: function theme_cvs_commit_message($commit) { ... but that should be around line 1018 of the copy of cvs.module you're looking at, or you're patching the wrong version. ;) thanks! -derek p.s. there's an issue for this already. please search for it before you create a new one (i'd find it for you, but i have to run...)
Op dinsdag 14 november 2006 08:37, schreef Dries Buytaert:
Better yet, _always_ write descriptive commit messages. At all times, keep in mind that people are tracking your projects by reading your commit messages -- either on the website, in their RSS feeds, or by e-mail. Simply put: the quality of your commit messages determines how people perceive you and your projects ...
Can we make som copy-pastable templates? IF people can copy-paste a start into the message, that will lower the barriers to make proper messages, AND it will introduce some consistency. Bèr Gold Silver yadyadiya: Patch committed #[issue number] by [username]. A bug in [filename(s)] caused [short description of the problem]. This commit solves this by: * [first solution or change] * [second solution or change] * [third solution or change] * Adding $foo as parameter to the API call module_function() in bar. [Optional short note on the effects for code calling your APIs or functions, or users using your modules.] -- Drupal, Ruby on Rails and Joomla! development: webschuur.com | Drupal hosting: sympal.nl
On 11/17/06, Bèr Kessels <ber@webschuur.com> wrote:
Can we make som copy-pastable templates? IF people can copy-paste a start into the message, that will lower the barriers to make proper messages, AND it will introduce some consistency.
Add/modify this handbook page [1] The template exists (though it's less than you describe). And there's also this idea to make the template a part of the issue automatically so that committers can copy/paste. That makes it more important to have accurate titles which is important but often ignored right now. [1] http://drupal.org/node/52287 [2] http://drupal.org/node/98165 Regards, Greg
participants (9)
-
Angela Byron -
Bèr Kessels -
Darrel O'Pry -
Derek Wright -
Dries Buytaert -
Greg Knaddison - GVS -
James Walker -
Khalid B -
Moshe Weitzman