Addressing this part in isolation, I hope you're joking
I was half joking and half serious.
The more complex or the more functionality a module has, the more the Change Log is needed. I fully realise that it is important. But, in this case, the module is pretty simple and the change is rather minor, albeit to make it work again. So perhaps a better option would have been ignore it until the next release.
One file I have left as Module::Starter created it is the README.
I am not sure there is anything useful I can put in there that isn't already in POD.
Thoughts of README?
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.
|
