[122833] trunk/doc-new/guide/xml/project.xml

[cal at macports.org]

Revision: 122833
          https://trac.macports.org/changeset/122833
Author:   cal at macports.org
Date:     2014-07-31 08:22:23 -0700 (Thu, 31 Jul 2014)
Log Message:
-----------
guide: Improve section on contributing enhancements

Modified Paths:
--------------
    trunk/doc-new/guide/xml/project.xml

Modified: trunk/doc-new/guide/xml/project.xml
===================================================================
--- trunk/doc-new/guide/xml/project.xml	2014-07-31 14:22:30 UTC (rev 122832)
+++ trunk/doc-new/guide/xml/project.xml	2014-07-31 15:22:23 UTC (rev 122833)
@@ -368,17 +368,27 @@
 
       <para>Enhancements to existing ports may comprise new functionality for
       a given port, bug fixes or even simple version updates. They should
-      always be contributed as <filename>Portfile</filename> patches. See
-      Ticket Submission Guidelines above for a description of all
-      fields.</para>
+      always be contributed as patches against the current
+      <filename>Portfile</filename>. See the <link
+        linkend="project.tickets">Ticket Submission Guidelines</link> for
+      a description of all fields.</para>
 
       <orderedlist>
         <listitem>
-          <para>Create a <filename>Portfile</filename> patch with your changes
-          as described in Portfile Development.</para>
+          <para>Create a <filename>Portfile</filename> patch with your changes.
+            See <link linkend="development">Portfile Development</link> for
+            more information on how to edit Portfiles.</para>
         </listitem>
 
         <listitem>
+          <para>Please run
+            <programlisting><prompt>%%</prompt> <userinput>port lint --nitpick $portname</userinput></programlisting>
+            where <userinput>$portname</userinput> is the name of the port you
+            modified. Please fix any warnings and errors before submitting your
+            changes.</para>
+        </listitem>
+
+        <listitem>
           <para>Create a Trac ticket.</para>
         </listitem>
 
@@ -393,9 +403,27 @@
         </listitem>
 
         <listitem>
+          <para>Put the maintainer's email address into the
+            <guilabel>Cc</guilabel> field. You can use
+            <programlisting><prompt>%%</prompt> <userinput>port info --maintainer $portname</userinput></programlisting>
+            where <userinput>$portname</userinput> is the name of the port you
+            want to modify. Note that
+            <email>openmaintainer at macports.org</email> and
+            <email>nomaintainer at macports.org</email> are not real people and should thus not be Cc'd.</para>
+        </listitem>
+
+        <listitem>
           <para>Attach your Portfile patch file and any new or changed patch
-          files (don't patch patches) to the ticket.</para>
+            files to the ticket.</para>
         </listitem>
+
+        <listitem>
+          <para>If your ticket doesn't receive any attention within a few days
+            (for example, because the port you are trying to modify does not
+            have a maintainer), you may email
+            <email>macports-dev at lists.macosforge.org</email> and request
+            a review and/or commit.</para>
+        </listitem>
       </orderedlist>
     </section>
   </section>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20140731/8b175fa8/attachment.html>