incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r645398 - in /incubator/public/trunk: site-author/guides/mentor.xml site-publish/guides/mentor.html
Date Mon, 07 Apr 2008 06:52:50 GMT
Author: rdonkin
Date: Sun Apr  6 23:52:49 2008
New Revision: 645398

URL: http://svn.apache.org/viewvc?rev=645398&view=rev
Log:
Added section on code import best practices

Modified:
    incubator/public/trunk/site-author/guides/mentor.xml
    incubator/public/trunk/site-publish/guides/mentor.html

Modified: incubator/public/trunk/site-author/guides/mentor.xml
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-author/guides/mentor.xml?rev=645398&r1=645397&r2=645398&view=diff
==============================================================================
--- incubator/public/trunk/site-author/guides/mentor.xml (original)
+++ incubator/public/trunk/site-author/guides/mentor.xml Sun Apr  6 23:52:49 2008
@@ -267,29 +267,110 @@
         attached to JIRA then it MUST be committed to version control.
         </p>
       </section>
-      <section id='initial-clean-up'><title>Initial Clean Up</title>
+      <section id='initial-clean-up'>
+        <title>Initial Clean Up</title>
+        <p>
+          Once a JIRA has been created, the source should be cleaned up.
+        </p>
         <p>
-        Once a JIRA has been created, the source should be cleaned up. 
-        </p><p>
           <ul>
-          <li>Ensure source files use the standard Apache boilerplates. This may mean
-          replacing existing license headers. The tools in
-          <code>https://svn.apache.org/repos/private/committers/tools</code>
-          and <code>https://svn.apache.org/repos/private/committers/relicense</code>
-          may be useful.
-          </li>
-          <li>Ensure that NOTICE and LICENSE documents are present and correct</li>
-          <li>Add any required notices. Consider moving copyright attributions 
-          from source documents to the NOTICE. Read 
-          <a href='http://www.apache.org/legal/src-headers.html'>Apache policy on headers</a>.</li>
-          <li>Audit the source for any potential licensing issues. Any which are found

-          should either resolved immediately (when required) or noted in the status
-          document for later.</li>
+            <li>
+              Ensure source files use the standard Apache boilerplates.
+              This may mean replacing existing license headers. The
+              tools in
+              <code>
+                https://svn.apache.org/repos/private/committers/tools
+              </code>
+              and
+              <code>
+                https://svn.apache.org/repos/private/committers/relicense
+              </code>
+              may be useful.
+            </li>
+            <li>
+              Ensure that NOTICE and LICENSE documents are present and
+              correct
+            </li>
+            <li>
+              Add any required notices. Consider moving copyright
+              attributions from source documents to the NOTICE. Read
+              <a href='http://www.apache.org/legal/src-headers.html'>
+                Apache policy on headers
+              </a>
+              .
+            </li>
+            <li>
+              Audit the source for any potential licensing issues. Any
+              which are found should either resolved immediately (when
+              required) or noted in the status document for later.
+            </li>
           </ul>
-        </p><p>
-        It is recommended that the initial clean up be is started before the code is committed.
-        It MUST be completed before any releases are cut.
         </p>
+        <p>
+          It is recommended that the initial clean up be is started
+          before the code is committed. It MUST be completed before any
+          releases are cut.
+        </p>
+        <section id='clean-up-best-practice'>
+          <title>Clean Up Best Practice</title>
+          <p>
+            It is recommended that version control is used to create a
+            public record of the process. This will assist anyone
+            auditing the code provenance (now or in the future) to
+            easily perform due diligence without contacting the people
+            who performed the clean up. The clean up process should
+            therefore clearly document (using version control) the
+            evolution of the IP licensing.
+          </p>
+          <p>
+            Particular care needs to be taken with commit messages
+            during clean up. The intended audience needs to include
+            lawyers and code auditors. Members of the public need to be
+            able to follow and understand the process from these
+            messages alone.
+          </p>
+          <p>
+            It is therefore recommended that the initial source is
+            (after being expanded from the archive) checked in as is
+            into a special directory (
+            <code>${project}/trunk/import</code>
+            is suggested). The original packaging, copyright statements
+            and license notices should be preserved. A standard Apache
+            LICENSE and appropriate NOTICE should be added at the top
+            for the copyright for the collective work (see
+            <a href='http://www.apache.org/legal/src-headers.html'>
+              policy
+            </a>
+            ). Take particular care with this commit message. As with
+            any patch that contains code which is not the original work
+            of the committer, the JIRA url (for the artifact imported)
+            needs to be included together with notes about the original
+            copyright owner and any associated paperwork. The fact that
+            this is a exact import including original headers should be
+            noted to stop any queries about these foreign headers.
+          </p>
+          <p>
+            The cleanup should then proceed in a number of commits. If
+            the source provenance is complex, break the process up into
+            a number of logical steps committing each in turn with a
+            good message.
+          </p>
+          <p>
+            In particular, take care when relocating copyright
+            statements and license notices into the NOTICE in the root
+            directory: consider moving each copyright owner individually
+            so that it is easier to audit. (See
+            <a
+              href='http://www.apache.org/legal/src-headers.html#notice'>
+              policy
+            </a>
+            .)
+          </p>
+          <p>
+            Once a section of code has been cleaned up (and repackaged,
+            if necessary) normal development can begin.
+          </p>
+        </section>
       </section>
       <section id='documents-clean-up'><title>Update Documents</title>
         <p>

Modified: incubator/public/trunk/site-publish/guides/mentor.html
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-publish/guides/mentor.html?rev=645398&r1=645397&r2=645398&view=diff
==============================================================================
--- incubator/public/trunk/site-publish/guides/mentor.html (original)
+++ incubator/public/trunk/site-publish/guides/mentor.html Sun Apr  6 23:52:49 2008
@@ -185,6 +185,12 @@
 <li><a href='#initial-clean-up'>
 Initial Clean Up
  </a>
+ <ul>
+<li><a href='#clean-up-best-practice'>
+Clean Up Best Practice
+ </a>
+</li>
+</ul>
 </li>
 <li><a href='#documents-clean-up'>
 Update Documents
@@ -526,29 +532,108 @@
 </h4>
 <div class="section-content">
 <p>
-        Once a JIRA has been created, the source should be cleaned up. 
+          Once a JIRA has been created, the source should be cleaned up.
         </p>
 <p>
           <ul>
-          <li>Ensure source files use the standard Apache boilerplates. This may mean
-          replacing existing license headers. The tools in
-          <code>https://svn.apache.org/repos/private/committers/tools</code>
-          and <code>https://svn.apache.org/repos/private/committers/relicense</code>
-          may be useful.
-          </li>
-          <li>Ensure that NOTICE and LICENSE documents are present and correct</li>
-          <li>Add any required notices. Consider moving copyright attributions 
-          from source documents to the NOTICE. Read 
-          <a href="http://www.apache.org/legal/src-headers.html">Apache policy on headers</a>.</li>
-          <li>Audit the source for any potential licensing issues. Any which are found

-          should either resolved immediately (when required) or noted in the status
-          document for later.</li>
+            <li>
+              Ensure source files use the standard Apache boilerplates.
+              This may mean replacing existing license headers. The
+              tools in
+              <code>
+                https://svn.apache.org/repos/private/committers/tools
+              </code>
+              and
+              <code>
+                https://svn.apache.org/repos/private/committers/relicense
+              </code>
+              may be useful.
+            </li>
+            <li>
+              Ensure that NOTICE and LICENSE documents are present and
+              correct
+            </li>
+            <li>
+              Add any required notices. Consider moving copyright
+              attributions from source documents to the NOTICE. Read
+              <a href="http://www.apache.org/legal/src-headers.html">
+                Apache policy on headers
+              </a>
+              .
+            </li>
+            <li>
+              Audit the source for any potential licensing issues. Any
+              which are found should either resolved immediately (when
+              required) or noted in the status document for later.
+            </li>
           </ul>
         </p>
 <p>
-        It is recommended that the initial clean up be is started before the code is committed.
-        It MUST be completed before any releases are cut.
-        </p>
+          It is recommended that the initial clean up be is started
+          before the code is committed. It MUST be completed before any
+          releases are cut.
+        </p>
+<h5> 
+   <a name="clean-up-best-practice">Clean Up Best Practice</a> 
+</h5> 
+<div class="section-content">
+<p>
+            It is recommended that version control is used to create a
+            public record of the process. This will assist anyone
+            auditing the code provenance (now or in the future) to
+            easily perform due diligence without contacting the people
+            who performed the clean up. The clean up process should
+            therefore clearly document (using version control) the
+            evolution of the IP licensing.
+          </p>
+<p>
+            Particular care needs to be taken with commit messages
+            during clean up. The intended audience needs to include
+            lawyers and code auditors. Members of the public need to be
+            able to follow and understand the process from these
+            messages alone.
+          </p>
+<p>
+            It is therefore recommended that the initial source is
+            (after being expanded from the archive) checked in as is
+            into a special directory (
+            <code>${project}/trunk/import</code>
+            is suggested). The original packaging, copyright statements
+            and license notices should be preserved. A standard Apache
+            LICENSE and appropriate NOTICE should be added at the top
+            for the copyright for the collective work (see
+            <a href="http://www.apache.org/legal/src-headers.html">
+              policy
+            </a>
+            ). Take particular care with this commit message. As with
+            any patch that contains code which is not the original work
+            of the committer, the JIRA url (for the artifact imported)
+            needs to be included together with notes about the original
+            copyright owner and any associated paperwork. The fact that
+            this is a exact import including original headers should be
+            noted to stop any queries about these foreign headers.
+          </p>
+<p>
+            The cleanup should then proceed in a number of commits. If
+            the source provenance is complex, break the process up into
+            a number of logical steps committing each in turn with a
+            good message.
+          </p>
+<p>
+            In particular, take care when relocating copyright
+            statements and license notices into the NOTICE in the root
+            directory: consider moving each copyright owner individually
+            so that it is easier to audit. (See
+            <a href="http://www.apache.org/legal/src-headers.html#notice">
+              policy
+            </a>
+            .)
+          </p>
+<p>
+            Once a section of code has been cleaned up (and repackaged,
+            if necessary) normal development can begin.
+          </p>
+</div>
 </div>
 <h4>
    <a name="documents-clean-up">Update Documents</a>



---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@incubator.apache.org
For additional commands, e-mail: cvs-help@incubator.apache.org


Mime
View raw message