For Programmers: Free Programming Magazines  


Home > Archive > PHP PEAR Questions and Answers > January 2005 > some action









You are viewing an archived Text-only version of the thread. To view this thread in it's original format and/or if you want to reply to this thread please [click here]

 

Author some action
Lukas Smith

2005-01-21, 8:57 am

Hi,

I wanted to bring up the following idea.

Once we have the wiki up. We should define rules on how documentation
should be written in the wiki. Preferably in a manner that will allow us
export to docbook (immediatly or eventually). Once we have define this
we will make a call in pear-general for "user appreciation" or something
like that were we suggest that every user do one of the following for
every 3 packages they have used in a project recently:

- write a chapter on how to use a particular feature of their favorite
package (similar to
http://pear.php.net/manual/en/packa...portability.php)
- write API documentation for 5 methods

As documenting things is likely to bring up some questions or even bug
reports due to closer examination of special cases this will be followed
up by a "developer appreciation" bug hunt. Where developers can adopt
packts of 5 open bug reports. The bug packages will be put together by
the QA team and should be coherent (either on a specific package, or a
specific issue spanning multiple packages etc). Developers are of course
free to pick up more bug packs.

Also lead maintainers are allowed to opt out with their packages. Those
who dont opt out allow the person who took up the pack to mess around
with the bug report etc. They dont grant that person to mess with CVS
though (although they may do so if they wish), so the person handling
the bug pack should submit patches inside the bug report.

The maintain is then free to apply the patch within the regulations that
we set when we founded the QA team.

regards,
Lukas
Sponsored Links







Also available: Server administration forum archive | Web Design forum archive | Software forum archive | Hardware reviews archive

Copyright 2008 codecomments.com