RE: enriching raw code [was Re: discovering public repository items?]

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

RE: enriching raw code [was Re: discovering public repository items?]

Steven Kelly
From: Jaroslaw Podgajny [mailto:[hidden email]]
> The question is what can be done to make it more natural to put
comments
> in all beneficial places.

Good call! I suggest that when publishing a pundle you should be warned
if the pundle comment or its version comment is empty.

Back in our Envy days, I changed the publish code that requested a
version comment to include the following text as an initial default
value:

<CurrentUser> is too lazy to write version comments

That cut down the number of times when people didn't write a proper
comment far better than my previous exhortations!

Another thing that would encourage good version comments is if the
Publish dialog could show the changes from the previous version (Compare
with Parent). Especially when publishing Bundles I find it's a pain to
manually open the version comments for each package. Mostly the packages
in the bundle have no open changes (I've already published them, or then
loaded the latest version someone else published), and it would be great
to have the default bundle version comment be calculated from the
package version comments - something like:

Package 1:
4.5: Fixed bug 1
4.6: Added new wibble feature
4.6.1: Fixed horrid wibble bug

Package 2:
1.1: Refactored for wibble compatibility

Some might argue that the bundle shouldn't have its own version comment,
but should simply calculate and show that list. Myself, I prefer to do a
little work on the bundle comment, removing descriptions of minor
changes and editing so that it makes a reasonable-sized, readable whole.


Steve