in reply to Re^2: Open sourcing perlmonks
in thread Open sourcing perlmonks

Darn. Seems like I should have been more explicit. ;-)

For starters, I am not looking for an explanation - I'm looking for a pmdev-guide (tye assures me there is one, but I've gone back in the wiki a fair bit without finding one or a link to one). One that explains what is expected from those in the pmdev, one that explains the rules of the gods on applying patches, one that shows this relationship. One that is also dynamic - as the rules are changed (whether evolution or revolution), somewhere for the appropriate god to update. One that can explain to the non-pmdevil what to expect should s/he put his/her name in the hat. Because I know at least one pmdevil who is yet to know what it's like to submit a patch; because I know I didn't really know what to expect when I offered to write that patch.

This would also help the gods who are less than becoming in their manner or style of rejection. It's much less personal to point at a prewritten, yet living and dynamic, document than to gruffly say (paraphrasing here) "I don't like it, I'm not approving it." It will help promote writing patches because it gives a guideline to all. You get better behaviour out of people when they can predict, with 100% accuracy, the consequences of their actions. In this case, if the pmdevil can predict, with 100% accuracy, whether their patch will be accepted or not, they can then start producing acceptable patches. Or they can know whether to expect some sort of reticence, and provide reasonable explanation along with their patch.

This should be a document that is referred to often - to the point where it's a common-knowledge document, like How (Not) To Ask A Question seems to be. Rather than pointing petitioners such as bofh_of_oz or artist (or even myself) to become pmdevils themselves to write and submit patches, they should be referred to this document, just as we point people who post bad questions to jeffa's How (Not) To Ask A Question. Because, as should be evident by the small number of people who are actually becoming pmdevils vs merely complaining about feature requests, we can't read the gods' minds no matter how much you may want us to.

Now, as for actually initiating this document, yeah, yeah, become a member of the SDC and write it myself. I know. :-)

On to a slight change in topic - below you wrote:

Once this has been done reviewing the code is fairly easy and IMO mostly intuitive.
I find this very entertaining. :-) To be honest, intuitive is only because you've been doing it a long time. I find the 15,000-line behemoth I designed/wrote at work to be fairly intuitive, too. The poor guy who is taking it over from me isn't so sure ;-)

Replies are listed 'Best First'.
Re^4: Open sourcing perlmonks
by demerphq (Chancellor) on May 28, 2005 at 17:41 UTC

    To be honest, intuitive is only because you've been doing it a long time.

    Well, im not sure that I agree with you. I found the PmDev Nodelet to be quite intuitive. It shows you the basic data on the type of node you are viewing, what display page associated to that nodetype was used for rendering the page, it give you ways to view the code of the node being rendered if its relevent, abilities to show the container structure, view the type heirarchy, view lists of nodes by type and to view the master list of site patches. All of this on top of being able to search the full codebase of the site, (with grep capabilities) and links to offsite documentation which although not specific to PM is still very useful.

    Im not sure what of the above isnt intuitive. Maybe if I did I could document it better. :-)

    ---
    $world=~s/war/peace/g

      First off, intuitive is all in the eye of the beholder. Which is what I was saying about my perl project at work.

      Second, when I first wanted to do the vote patch, it did take me a few days to figure my way around things. If there was a document like this to explain even just the PmDev Nodelet, it would have been nice to have:

      #xxxxxx
      Node number being used to display the current document.
      = <node type>
      Type of document the above node is see this to see an explanation of all the node types.
      via <blah>
      I'm not sure what this is... here is a document that explains the different types
      Dump Fields
      Dumps the fields - you can only dump all the data about the current node if you have certain authorities which are ...
      ...
      ...
      Everything Bible
      Mandatory reading - too bad it's too new for the level of Everything we're using here.
      ...
      ...
      And, of course, there'd be an extra entry - "PmDev Help" - that would point to this doc. But, really, what I was referring to that I thought was not intuitive is just following around all the code. On one hand, it's great - it's hugely modular. On the other hand, a web browser is not the most conducive method for reading/writing code that is spread out all over the place ;-)

        You'll see a new link in the pmdev nodelet to the pmdev howto wiki. Please add or update whatever you think is relevent. Ive done a first go at explaining the pmdev nodelet itself, maybe you could add whatever you think is relevent.

        ---
        $world=~s/war/peace/g