Details

    • Type: Sub-task
    • Status: Closed
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: Trunk
    • Fix Version/s: 16.11.01
    • Component/s: product
    • Labels:
      None

      Description

      A readme should be the first starting point of each component for developers, and have references to the placeholder in the wiki, in jira and in svn/viewvc.

        Activity

        Hide
        pfm.smits Pierre Smits added a comment -

        This patch addresses the issue.

        Show
        pfm.smits Pierre Smits added a comment - This patch addresses the issue.
        Hide
        taher Taher Alkhateeb added a comment -

        You have to be careful in your copy-pasting. The name of the component is wrong in the patch. This is why Again I recommend doing all the components in one shot with one patch in one jira to avoid wasting time in checking every JIRA. I also recommend removing the apache header since it is not required in README files and gets in the way of providing these very short sentences

        Show
        taher Taher Alkhateeb added a comment - You have to be careful in your copy-pasting. The name of the component is wrong in the patch. This is why Again I recommend doing all the components in one shot with one patch in one jira to avoid wasting time in checking every JIRA. I also recommend removing the apache header since it is not required in README files and gets in the way of providing these very short sentences
        Hide
        pfm.smits Pierre Smits added a comment -

        Revised patch, including OFBiz logo and correct component name.

        Show
        pfm.smits Pierre Smits added a comment - Revised patch, including OFBiz logo and correct component name.
        Hide
        pfm.smits Pierre Smits added a comment -

        Thanks Taher,

        I guess I shouldn't do this after a rough, short night without a proper good morning coffee.

        Show
        pfm.smits Pierre Smits added a comment - Thanks Taher, I guess I shouldn't do this after a rough, short night without a proper good morning coffee.
        Hide
        jacques.le.roux Jacques Le Roux added a comment -

        I agree with Taher oin 2 points here:

        • no need for tons of subtasks, they could have been done in a sole issue.
        • The ASL2 headers should be removed, not only in those files but in all where it's not needed, easier to read and less useless lines
        Show
        jacques.le.roux Jacques Le Roux added a comment - I agree with Taher oin 2 points here: no need for tons of subtasks, they could have been done in a sole issue. The ASL2 headers should be removed, not only in those files but in all where it's not needed, easier to read and less useless lines
        Hide
        pfm.smits Pierre Smits added a comment -

        Re 1: I don't see any contributor doing this kind of stuff in one go/one issue; there are examples all over where placeholders (OFBIZ-7536,OFBIZ-7334, OFBIZ-7828, etc.) have been created with sub tasks associated. This serves a purpose.

        Re 2: It is required to have legal references (in this case) the ASL2 header to be incorporated in piece of work that can be regarded as having any degree of creativity. Otherwise there remains an ambiguity with respect to licensing of that particular piece work. Feel free to take this up with legal. It has been discussed before there.

        Show
        pfm.smits Pierre Smits added a comment - Re 1: I don't see any contributor doing this kind of stuff in one go/one issue; there are examples all over where placeholders ( OFBIZ-7536 , OFBIZ-7334 , OFBIZ-7828 , etc.) have been created with sub tasks associated. This serves a purpose. Re 2: It is required to have legal references (in this case) the ASL2 header to be incorporated in piece of work that can be regarded as having any degree of creativity. Otherwise there remains an ambiguity with respect to licensing of that particular piece work. Feel free to take this up with legal. It has been discussed before there.
        Hide
        jacques.le.roux Jacques Le Roux added a comment -

        Thanks Pierre,

        Your slighlty modified patch is in trunk at revision: 1758179

        I have removed the useless ASL2 header (it's then more legible) and Capitalised the Product word

        For the license point in readme files please read http://www.apache.org/legal/src-headers.html#faq-exceptions

        If you think the readme files you created for this main task are creative then we might discuss this on dev ML... Note that the main intention, as explained in the link above is

        The expectation is that these files make it obvious which product they relate to.

        Show
        jacques.le.roux Jacques Le Roux added a comment - Thanks Pierre, Your slighlty modified patch is in trunk at revision: 1758179 I have removed the useless ASL2 header (it's then more legible) and Capitalised the Product word For the license point in readme files please read http://www.apache.org/legal/src-headers.html#faq-exceptions If you think the readme files you created for this main task are creative then we might discuss this on dev ML... Note that the main intention, as explained in the link above is The expectation is that these files make it obvious which product they relate to.
        Hide
        pfm.smits Pierre Smits added a comment -

        Thanks Jacques. Your commit resulted in a merge conflict.

        Show
        pfm.smits Pierre Smits added a comment - Thanks Jacques. Your commit resulted in a merge conflict.
        Hide
        taher Taher Alkhateeb added a comment -

        What stuff? This is minimal work for maximum number of Jiras. This is breaking a simple task into very fine grained sub tasks. It makes more noise, more commits, more follow up, more reviews and more JIRAs unnecessarily. Such JIRAs just add noise and waste time and energy and inflate numbers inaacurately.

        Show
        taher Taher Alkhateeb added a comment - What stuff? This is minimal work for maximum number of Jiras. This is breaking a simple task into very fine grained sub tasks. It makes more noise, more commits, more follow up, more reviews and more JIRAs unnecessarily. Such JIRAs just add noise and waste time and energy and inflate numbers inaacurately.

          People

          • Assignee:
            jacques.le.roux Jacques Le Roux
            Reporter:
            pfm.smits Pierre Smits
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development