The task in this node is to link to resources and cite books or articles that a medium-grade Perl newcomer might study to address a specific project management task.

The specific project management task is:

Given: A project of some defined scope and nature (e.g., a utility module or a web application); and the ongoing process of creating files within it (e.g., code and documentation); and anticipating the needs to transfer, publish, and deploy this project.

Considerations: The project is developed on a Linux system and written primarily in Perl; Git has been chosen as VCS; and Module::Build as build/test/install tool. Targets include localhost, remote web host under author's control, GitHub, and CPAN.

Primary Goal: To organize those files into a working tree by good choice of filename and by nesting them within folders (directories) and those folders possibly within subfolders, also with well-chosen names.

Secondary Goal: To identify specific strategies for dealing with specific cases where it may be unwise or inconvenient to replicate working tree structure exactly when the project is transfered, deployed, copied, or published.

Dummies of appropriate content (not content of replies but content of resources; $$stuff not $ref):

Put all tests that actually execute (passing or failing) under the top-level folder t/. You might have a test for a feature not yet implemented; put that in a subfolder t/unimplemented/ and add it to MANIFEST.SKIP. Push it to GitHub but don't release it to CPAN.

Say you have a file config.txt that contains configuration data to be read by a web script upon startup. According to the discussion given previously (on page 167), that file should be stored in remotehost's path as ~/.config/myproject/config.txt. However, you do not want to keep that file there on localhost, since that would be outside of the project's enclosing folder. So, keep the file in file/config/myproject/config.txt and, for local development, employ the Wazoo workaround. Include file/config/myproject/ in your repo and in CPAN tarball releases. Also, add a rule to your JimminyCricket file (deploy.jimminy) that will cause the file to be copied out during the build to the appropriate deployment location. See JimminyCricket docs for more info on how to construct deviant install rules.

Feste: Misprison in the highest degree. Lady, cucullus non facit monachum. That's as much to say as, I wear not motley in my brain....

In reply to Re: Project Structure Revisited by Xiong
in thread Project Structure Revisited by Xiong

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.