[shrinkwrap-issues] [JBoss JIRA] (SHRINKRES-16) Write purpose statement and key goals document for Resolvers

Karel Piwko (JIRA) jira-events at lists.jboss.org
Mon May 27 11:28:06 EDT 2013


     [ https://issues.jboss.org/browse/SHRINKRES-16?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Karel Piwko updated SHRINKRES-16:
---------------------------------

    Fix Version/s: 2.0.0-beta-4

    
> Write purpose statement and key goals document for Resolvers
> ------------------------------------------------------------
>
>                 Key: SHRINKRES-16
>                 URL: https://issues.jboss.org/browse/SHRINKRES-16
>             Project: ShrinkWrap Resolvers
>          Issue Type: Task
>    Affects Versions: 1.1.0-alpha-2
>            Reporter: Dan Allen
>            Assignee: Andrew Rubinger
>             Fix For: 2.0.0-beta-4
>
>
> Write a purpose statement and key goals for Resolvers.
> This are "alpha"-stage documentation that serves two purposes:
> 1. makes sure you know where you are aiming, so you don't lose your way
> 2. allows other people to know what you are going for so they can help
> The text should remain fairly high-level. In a sense they are the requirements transcribed into purpose.
> Try to answer the following questions while writing it:
> 1. Why are you creating this software? What is the need?
> 2. How does the software plan to address this need? (e.g., fluent api for resolving artifacts, focusing initially on Maven resolution facility)
> 3. What stage is the software in? Where is it headed?
> To keep this task as lightweight as possible, the text can be drafted in a lightweight markup language such as markdown (though reStructuredText is preferred).
> The github repository wiki for ShrinkWrap Resolvers is preferred for hosting the draft (can be managed via the web UI or as a git repository).
> https://github.com/shrinkwrap/resolver/wiki
> The wiki supports just about all the lightweight markup languages, one of them being reStructuredText. See reference here: http://docutils.sourceforge.net/docs/user/rst/quickref.html

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira


More information about the shrinkwrap-issues mailing list