[jira] [Commented] (OFBIZ-6243) Have a readme in every component

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Commented] (OFBIZ-6243) Have a readme in every component

Nicolas Malin (Jira)

    [ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15443640#comment-15443640 ]

Taher Alkhateeb commented on OFBIZ-6243:
----------------------------------------

Repeating my comment from one of the subtasks :

- I do not think a README file in every component is necessary, disussions were happening instead on creating embedded documentation in the version control
- Even then, do we really that many sub tasks when every README file submitted is only a few lines if you exclude the apache header? This over inflates the JIRAs needlessly.

> Have a readme in every component
> --------------------------------
>
>                 Key: OFBIZ-6243
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-6243
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: Trunk
>            Reporter: Pierre Smits
>            Assignee: Jacques Le Roux
>             Fix For: Upcoming Branch
>
>
> A readme should be the first starting point of each component for developers have references to the placeholder in the wiki, in jira and in svn/viewvc



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)