[Bf-committers] Re: new features without release log

[Jean-Luc Peurière]

Le 18 déc. 06 à 13:25, Rui Campos a écrit :

> I'm the one doing the BlenderNation CVS reports, so, if you guys  
> have some
> ideas on how to improve the report I'm all ears.
>

As i said they are good and well presented for a blender news site,  
but a bit hard to scan quickly,
mostly because they are intended as PR (which is fine as it is for  
blendernation).

> Additionally, one thing that would help me alot from the developers  
> would
> be having a small header stating the purpose of each log ( much  
> like I've
> seen in some of the logs ).
>
> Example 1: == PYTHON > Bug fixing ==
> Example 2: == SEQUENCER > new feature ==
> Example 2: == NODES > Compositing > new feature ==

Yes, that would be a huge improvement and dont put too much burden on  
devs.

What is important is to agree on what is what. i could see the  
following list  :

* bug fix
* improvement (existing enhanced feature, or rework)
* new feature
* big stuff ( Need obviously a better name)

we could agree too on a list of types and subtypes.

obviously the last 2 items need a full description in release logs.

also beware of the wording when rephrasing the logs :
eg "New Camera options for Architects" means nothing much,
while both "the 2-point perspective Architecture Camera" and
"Camera lens shift for architecture" which were the titles of the pages
pointed by your links (resp patch & cvs log) were completely and  
accurately
describing the feature (the 2 wording means the same, one is art  
speaking, the other
photographic field).

I know that this is something sometimes hard to do when the committer  
used loosy
wording too, but when he is precise, try to reuse it. After all, the  
coder is
the best placed to describe accurately what he has done, and it is a  
small effort.

the "Read here" are quickly annoying ;)

PS: your effort on giving links to the logs themselves is very good.

-- 
Lukep
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://projects.blender.org/pipermail/bf-committers/attachments/20061218/28e32c8d/attachment.htm