Hi Sergio, On Fri, May 15, 2015 at 6:28 AM, Sergio Fedi <sergio.fedi@gmail.com> wrote:
Ok, I came up with this default comment.
Let's see what you guys think of it:
*This is a default comment for a package.*
*To create a new one follow these guidelines:*
* - Make the first line a one line description of the package and its purpose.* * - Describe with a more detailed description the problem solved and how the package works* * - Describe how to use the package with code snippets and what classes are the ones you'll use normally* * - Mention any side effect that may come from installing or uninstalling the package* * - Write information from the package like author, contact, repository, date of creation, etc.*
I would add: - describe how to load the package, including any additional dependencies, version requirements, etc. PD: I know the above should be modelled in the Manifest of the Package, but
it's better to have it in the comment while we don't have implemented them.
-- best, Eliot