[Fiware-ge-owners] URGENT: Incorporation of Roadmap section in FIWARE/Incubated GEs

[Juanjo Hierro]

Dear FIWARE and Incubated GE owners,

   As discussed in the last TSC of 2018, every FIWARE GE owner is 
expected to incorporate a standard "Roadmap" section in the README.md of 
their corresponding Repo on GitHub where they elaborate on their short 
term, medium and long term plans regarding evolution of their technology.

   This mail intends to bring you guidelines on how to complete such 
section.

   Please bear in mind that we were expecting this to be completed by 
you early in January.  This matter has now become urgent and it must be 
completed by January 28th (this is the absolute deadline).

   Here are the guidelines:

  * We would suggest that the Roadmap section starts with a standard
    text.  This would give overall impression of unity.  This is the
    suggested format:

    "This section elaborates on proposed new features or tasks to which
    are expected to be added to the product in the  foreseeable future.
      There should be  no assumption of a commitment to deliver these
    features on specific dates or in the order given. The development
    team will be doing their best to follow the proposed dates and
    priorities, but please bear in mind that plans to work on a given
    feature or task may be revised.  All information is provided for as
    a general guidelines only,  and this section may be revised to
    provide newer information at any time."

    If your product is a FIWARE GE, please add this paragraph:

    "This product is a FIWARE Generic Enabler.  If you would like to
    learn about the overall Roadmap of FIWARE, please check section
    "Roadmap" on the FIWARE Catalogue
    <https://github.com/Fiware/catalogue>."

    Similarly, if your product is an Incubated FIWARE GE, please add
    this paragraph:

    "This product is an Incubated FIWARE Generic Enabler.  If you would
    like to learn about the overall Roadmap of FIWARE, please check
    section "Roadmap" on the FIWARE Catalogue
    <https://github.com/Fiware/catalogue>."

  * Please structure the "Roadmap" section in three subsections with the
    following titles:
      o "Short term (next release of the product)"
      o "Medium term (9 months following next release)
      o "Long term (some time in the future)”

  * Please adopt the following structure per subsection:
      o <opening paragraph>
      o <bullet list of features/tasks> - this should be a simple list
        of features you plan to address in the given period.  Try to be
        comprehensive as well as short in the description of each
        feature (2 lines max).   If the description of a given feature
        will need more elaboration, please add the following text after
        end of the description: "(see more detailed description below)"
        and then create a subsection below or, alternatively, refer to
        PRs associated to implementation of the feature: "(see PRx, PRy,
        ...)" providing the link for each PR.
      o <subsections providing more details of selected features if
        needed> - this section would be needed if you plan to add
        further details as explained above (and not do it through
        references to PRs)

  * Use the following text (or similar) for the opening paragraph of the
    "Short term (next release of the product)" section:

    "The following list of features are planned to be addressed in the
    short term, and incorporated in the next release of the product
    planned for <date>:”

  * Use the following text (or similar) for the opening paragraph of the
    "Medium term (approximately 9 months following next release)" section:

    "The following list of features are planned to be addressed in the
    medium term, typically within the subsequent release(s) generated in
    the next 9 months after next planned release:”

  * Please use the following text (or similar) for the opening paragraph
    of the "Long term (sometime in the future)" section:

    "The following list of features are proposals regarding the
    longer-term evolution of the product even thought development of
    these features has not yet been scheduled for a release in the near
    future.  Please feel free to contact us if you wish to get involved
    in the implementation or influence the roadmap”


   Thanks for your collaboration in this important task.  These 
guidelines will be incorporated in the FIWARE Contributor 
recommendations <https://github.com/Fiware/contribution-requirements> as 
agreed also in the FIWARE TSC.  If you have any doubts, don't hesitate 
to ask.

   Best regards,

-- 

Juanjo Hierro
Chief Technology Officer
juanjose.hierro at fiware.org <mailto:juanjose.hierro at fiware.org>
www.linkedin.com/in/jhierro <https://www.linkedin.com/in/jhierro>
Twitter: @fiware <https://twitter.com/fiware> @JuanjoHierro 
<https://twitter.com/JuanjoHierro>





-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/fiware-ge-owners/attachments/20190117/998d4426/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: ijkdnbjaagadfkpi.png
Type: image/png
Size: 8678 bytes
Desc: not available
URL: <https://lists.fiware.org/private/fiware-ge-owners/attachments/20190117/998d4426/attachment-0001.png>