[prev in list] [next in list] [prev in thread] [next in thread] 

List:       opensolaris-website-discuss
Subject:    [website-discuss] draft "posting instructions" page
From:       Bonnie.Corwin () Sun ! COM (Bonnie Corwin)
Date:       2006-04-26 16:32:22
Message-ID: 44500302.1090902 () Sun ! COM
[Download RAW message or body]

Hi,

I've been working on a page of instructions for what people need to do
to post source and/or binaries on opensolaris.org.  I think the attached
draft is finally complete.  Input appreciated about what's not clear,
what's missing, etc.

I'd also appreciate suggestions about what the parent page should be and
where on opensolaris.org it would be helpful to cite pointers to this page.

Thanks.

Bonnie

-------------- next part --------------
4/26/06

Following is a checklist for use when posting source or binaries on
opensolaris.org.


* General

  - Community vs. Project

    Do you have a Community or Project space in which to post?

    See the *Communities* and *Projects* webpages for information about
    the differences, how to propose them and how to set them up.

  - Web pages

    Do you have a web page set up with information about your posting?

    - Trademarks

     - Solaris and OpenSolaris are trademarks used to identify
       Sun products/services, used as an adjective, followed by an 
       appropriate noun.  It is best/safest to not use these on 
       community and project webpages.

     - If you represent a Sun engineering team that is using a code 
       name, that name must be cleared for use.  It's better not to 
       use code names.

    - Licensing/Downloads

      Wherever you point to downloads or have downloads available, 
      licensing information must be posted and/or referenced so that 
      people can evaluate applicable licenses prior to downloading 
      anything.

* Posting Binaries

  - Only binaries that can be freely re-distributed by anyone may be
    posted on opensolaris.org.

  - Tarball Contents

    - Binaries

    - Licensing Information

      - If using the OpenSolaris Binary License: 

        - Include a text file that contains the text of the OpenSolaris
          Binary license.  Name this file: BINARYLICENSE.txt.   This
          file can be created using the *OpenSolaris Binary License* 
          text.

        - Include a file named: README.tarballname.arch

          See (pointer to text file) for a template of the contents
          of this file and instructions about how to populate it.

        - If some binaries are covered under other licenses,
          include a file named: THIRDPARTYLICENSE.tarballname.

          See (pointer to text file) for a template of the contents
          of this file and instructions about how to populate it.

      - If using the CDDL:

        If the binaries were built using only source covered by the
        CDDL, the binaries are also covered by the CDDL.  A text
        file must be included with the source that contains the 
        license text.  Such a file can be created using the *CDDL 
        License* text.

      - If using another license:

        If the binaries were built using one or more third-party 
        open source licenses, include a file in the tarball that 
        contains the third-party license text.

  - Tarball Naming Conventions

    - Notes

      * ACRONYM = Consolidation acronym

      * DESCRIPTION = description of the subset of the consolidation

      * NAME = [project choice]

      * DATE = YYYYMMDD

      * ARCH = i386/sparc/ppc

    - For Consolidations Providing Binaries Built from open source

      ACRONYM[-DESCRIPTION]-bins-DATE.ARCH.tar.bz2

      Examples:

       devpro-libm-bins-20051213.sparc.tar.bz2

       nws-bins-20061127.i386.tar.bz2

    - For Consolidations Providing Binaries Built from non-open source:

      ACRONYM[-DESCRIPTION]-closed-bins-DATE.ARCH.tar.bz2

      Examples:

       on-closed-bins-20060102.sparc.tar.bz2
  
       nws-closed-bins-20061127.i386.tar.bz2

     - For Projects Providing Binaries Built from open source:

       NAME-bins-DATE.ARCH.tar.bz2

     - For Projects Providing Binaries Built from non-open source:

       NAME-closed-bins-DATE.ARCH.tar.bz2


* Posting Source

  NOTE: 

  Until SCM support is available, source is posted on the website in 
  tarballs, and contributions are handled via manual processes by the 
  individual projects.  

  Once SCM support with direct access to source is available, processes 
  for managing that access will still be needed but will most likely 
  change from how they are handled today.  The following is about 
  tarballs and manual processes.  It will be updated once SCM support 
  becomes available.

  - FOR SUN EMPLOYEES ONLY

    See the *internal engineering website* for instructions about 
    required preparation of pre-existing Sun code.

  - Tarball Contents

    - Source Hierarchy

    - Licensing Information

      - If using the CDDL:

        - Text file at the top of the source hierarchy that contains the 
          full license text for the CDDL.  This file can be created using 
          the *CDDL License* text.

        - Make sure the CDDL comment block in the code references the
          correct name and location of the license text file in your 
          hierarchy.

    - Release Notes or a README that explains the source hierarchy,
      how to build, any depedencies, etc.

  - Tarball Naming Convention

    - Notes

      * ACRONYM = Consolidation Acronym

      * DESCRIPTION = description of the subset of the consolidation

      * NAME = [project choice]

      * DATE = YYYYMMDD

    - For Consolidations

      ACRONYM[-DESCRIPTION]-src-DATE.tar.bz2

      Examples:

       on-src-20060102.tar.bz2
  
       devpro-libm-src-20051213.tar.bz2

       nws-src-20061127.tar.bz2

     - For Projects

       NAME-src-DATE.tar.bz2

  - Contributions

    - Non-Sun community members must file a signed Contributor's Agreement
      prior to making contributions to OpenSolaris.  The agreement, 
      information about it and instructions about how to file it are found 
      on the *Sun Contributor's Agreement" page.

    - You must have a way to take contributions related to the source you 
      post whether the source is available via tarballs or directly through 
      an SCM system.  

    - You must have a way to report the following information related to 
      contributions.
     
      Roll-up information:

      # of contributions offered to date
      # of contributions integrated into the code base to date
      # of contributions not integrated and reason(s)
      # of contributions currently being worked on
      # of contributions waiting to be worked/decided on
 
      Detailed information:

      For each contribution integrated into the code base,
 
      - name of the external contributor
      - name of the Sun engineer who facilitated the integration
      - short description of the contribution - where applicable, 
        bugster ID/description is preferable

    - If you are a consolidation: 
      - You may use the request-sponsor alias or create a mechanism unique 
        to your consolidation.  
      - You must have at least one representative on request-sponsor 
        regardless of the mechanism you use in order to catch any 
        contribution offers that come through that alias for your 
        consolidation.

    - If you are a project, the expectation is that you will develop your 
      own process that will usually be lightweight. 

[prev in list] [next in list] [prev in thread] [next in thread]