On 3/7/06, Tim O'Brien <[EMAIL PROTECTED]> wrote: > Developers don't write great documentation. Don't raise the bar so high > that people are discouraged from submitting doco-less patches. Just create > a structure to address documentation deficiency. +1
Patches should be able to be SUBMITTED without documenation, but not committed. Committers can decide if a patch with just a code fix is valuable enough they'll spend the time to document or even add testing for it. Anything that discourages non-committers from contributing is a bad idea. > 1. Create a documentation posse - identify people who will focus solely on > doco, reduce the barriers for them to commit. Or, move documentation to an > external project with lower barriers to entry. > > 2. Consider a separate list - people removed from the development process > produce better documentation. > > 3. Add "Waiting for Documentation" as a stage in a customized JIRA > workflow. Instead of creating separate issues for "Document what I just did > in the Site Plugin", give developers the opportunity to just mark something > as implemented but undocumented (otherwise know n as useless and invisible) +1 Add something similar to indicate that it's waiting for test coverage also. --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
