Changeset 26582 for trunk/doc


Ignore:
Timestamp:
Jun 29, 2007, 5:19:53 AM (11 years ago)
Author:
jmpp@…
Message:

Partly adapt guidelines for ticket submission into trac tickets (leaving behind bugzilla times),
applying a heavily modified patch from Brian Campbell in #12199 to make room for remaining trac
ticket fields (not in the patch).

Most new fields are there only as place holders, content for each still needs to be written.
Already existing content also needs bringing up to speed, I didn't go over it (this is just a
reorganization commit).

Thanks to Brian Campbell for all the help! (yes, and it's *Brian*, not Bill as Id' been saying up
till now). Closes #12199.

PS: Please test guide regen thouroughly, I changed quite a few things around and may have broken it!

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/xml/project/submission.xml

    r26580 r26582  
    2323                associated patches scripts, etc allows us to keep track of port
    2424                submissions, process them efficiently and get them submitted as
    25                 quickly as possible to our mports Subversion tree. The following sections
     25                quickly as possible to our ports tree in Subversion. The following sections
    2626                will describe the standard port submission procedures. </para>
    2727               
     
    3131                        <para> All ports should be submitted via the MacPorts
    3232                        <ulink url="http://trac.macports.org/project/macports/newticket">Trac tool
    33                         </ulink>. Your submission will be automatically emailled to the
    34                         members of the
    35                         <ulink url="http://lists.macosforge.org/mailman/listinfo/macports-tickets">
    36                         macports-tickets</ulink> mailing list. If you are uncertain about
     33                        </ulink>. If you are uncertain about
    3734                        any aspect of your port, you may also want to email it with your
    38                         questions and the bug number to 
     35                        questions and the ticket number to 
    3936                        <ulink url="mailto:macports-dev@lists.macosforge.org">MacPorts</ulink>
    4037                        mailing list.</para>
     
    4441                        in your Trac submission, so that the automatic email is
    4542                        directed to the maintainer, who will be best suited to deal
    46                         with your submission.</para>
     43                        with your submission. Also, due to a current misconfiguration in Trac,
     44                        add the current maintainer to the <guilabel>Cc</guilabel> field, to make
     45                        sure they are notified.</para>
    4746                       
    4847                        <para>Updates and modifications should be submitted as diffs. See
     
    6261                               
    6362                                <variablelist>
    64                                         <varlistentry id='Project'>
    65                                                 <term>
    66                                                         Project:
    67                                                 </term>
    68                                                 <listitem>
    69                                                         <para>Make sure you select the MacPorts
    70                                                         project.</para>
    71 
    72                                                 </listitem>
    73                                         </varlistentry>
    74                                        
     63                                       
     64                                        <varlistentry id='Summary'>
     65                                                <term>
     66                                                        Short summary:
     67                                                </term>
     68                                                <listitem>
     69                                                        <para>The summary field should provide a brief explanation
     70                                                        of purpose of the ticket. </para>
     71                                                </listitem>
     72                                        </varlistentry>
     73
     74                                        <varlistentry id='Type'>
     75                                                <term>
     76                                                        Type:
     77                                                </term>
     78                                                <listitem>
     79                                                </listitem>
     80                                        </varlistentry>
     81
     82                                        <varlistentry id='Description'>
     83                                                <term>
     84                                                        Full description:
     85                                                </term>
     86                                                <listitem>
     87                                                        <para>The description field should contain the
     88                                                        following information as per the example given
     89                                                        here. </para>
     90
     91                                                                <programlisting>
     92<![CDATA[
     93Portname-1.2.3
     94
     95the portfile can be found here: URL or ATTACHED
     96
     97Description: What does this program do in a nutshell,
     98briefly what changes were made, or what files you are attaching in the tarball.
     99
     100Homepage: URL of project or program itself, not the portfile
     101
     102Comments: Any comments you have about your port, concerns, lookouts,
     103dependencies that you may want to mention
     104--
     105your sig if you'd like
     106]]>
     107                                                </programlisting>
     108                                                               
     109                                                </listitem>
     110                                        </varlistentry>
     111
     112                                        <varlistentry id='Priority'>
     113                                                <term>
     114                                                        Priority:
     115                                                </term>
     116                                                <listitem>
     117                                                </listitem>
     118                                        </varlistentry>
     119
    75120                                        <varlistentry id='Component'>
    76121                                                <term>
     
    78123                                                </term>
    79124                                                <listitem>
    80                                                         <para>Select "mports" as the component. </para>
    81 
    82                                                 </listitem>
    83                                         </varlistentry>
    84                                        
    85                                         <varlistentry id='Assigned_to'>
    86                                                 <term>
    87                                                         Assigned to:
     125                                                        <para>Select "ports" as the component if you're submitting a change to an existing port or a new port. Select the appropriate component if you're submitting a change to a different part of the project.</para>
     126
     127                                                </listitem>
     128                                        </varlistentry>
     129
     130                                        <varlistentry id='Severity'>
     131                                                <term>
     132                                                        Severity:
     133                                                </term>
     134                                                <listitem>
     135                                                </listitem>
     136                                        </varlistentry>
     137
     138                                        <varlistentry id='Assing_to'>
     139                                                <term>
     140                                                        Assign to:
    88141                                                </term>
    89142                                                <listitem>
     
    94147
    95148                                                </listitem>
    96                                         </varlistentry>
    97                                         <varlistentry id='URL'>
    98                                                 <term>
    99                                                         URL:
    100                                                 </term>
    101                                                 <listitem>
    102                                                         <para>You may use this field to point to the
    103                                                         portfile if it is available online, or to point
    104                                                         to the homepage of the program project.</para>
    105 
    106                                                 </listitem>
    107                                         </varlistentry>
    108                                         <varlistentry id='Summary'>
    109                                                 <term>
    110                                                         Summary:
    111                                                 </term>
    112                                                 <listitem>
    113                                                         <para>The summary field should one of a number
    114                                                         of standardised elements, </para>
    115 
     149                                        </varlistentry>
     150
     151                                        <varlistentry id='Milestone'>
     152                                                <term>
     153                                                        Milestone:
     154                                                </term>
     155                                                <listitem>
     156                                                        <para>Milestone explanation here!</para>
    116157                                                                <variablelist>
    117158                                                                        <varlistentry id='NEW_portname'>
     
    192233                                                                        </varlistentry>
    193234                                                                </variablelist>
    194                                                                
    195                                                 </listitem>
    196                                         </varlistentry>
    197                                         <varlistentry id='Description'>
    198                                                 <term>
    199                                                         Description:
    200                                                 </term>
    201                                                 <listitem>
    202                                                         <para>The description field should contain the
    203                                                         following information as per the example given
    204                                                         here here. </para>
    205 
    206                                                                 <programlisting>
    207 <![CDATA[
    208 Portname-1.2.3
    209 
    210 the portfile can be found here: URL or ATTACHED
    211 
    212 Description: What does this program do in a nutshell,
    213 briefly what changes were made, or what files you are attaching in the tarball.
    214 
    215 Homepage: URL of project or program itself, not the portfile
    216 
    217 Comments: Any comments you have about your port, concerns, lookouts,
    218 dependencies that you may want to mention
    219 --
    220 your sig if you'd like
    221 ]]>
    222                                                 </programlisting>
    223                                                                
    224                                                 </listitem>
    225                                         </varlistentry>
     235                                                </listitem>
     236                                        </varlistentry>
     237
     238                                        <varlistentry id='Version'>
     239                                                <term>
     240                                                        Version:
     241                                                </term>
     242                                                <listitem>
     243                                                </listitem>
     244                                        </varlistentry>
     245
     246                                        <varlistentry id='Keywords'>
     247                                                <term>
     248                                                        Keywords:
     249                                                </term>
     250                                                <listitem>
     251                                                </listitem>
     252                                        </varlistentry>
     253
     254                                        <varlistentry id='Cc'>
     255                                                <term>
     256                                                        Cc:
     257                                                </term>
     258                                                <listitem>
     259                                                </listitem>
     260                                        </varlistentry>
     261                                       
    226262                                </variablelist>
    227263                               
Note: See TracChangeset for help on using the changeset viewer.