Changeset 153048 for trunk/doc-new


Ignore:
Timestamp:
Sep 22, 2016, 9:38:01 PM (2 years ago)
Author:
cal@…
Message:

guide: Add tl;dr to ticket guidelines, cleanup

Add a quick overview table so people don't have to read the full 700-word
ticket guidelines. Also, remove the limitation of infrastructure tickets to
portmgr@ (which has not been done in practice anyway) and link to the ticket
keyword guidelines in the wiki.

Ticket: #52331

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc-new/guide/xml/project.xml

    r153045 r153048  
    109109      <title>Trac Ticket Guidelines</title>
    110110
     111      <para>This is a short overview of the guidelines for Trac tickets. Please
     112        see below for longer and more detailed explanations.</para>
     113
     114      <tip>
     115        <title>TL;DR</title>
     116        <informaltable frame="none">
     117          <tgroup cols="2">
     118            <thead>
     119              <row>
     120                <entry>Field</entry>
     121                <entry>Content</entry>
     122              </row>
     123            </thead>
     124            <tbody>
     125              <row>
     126                <entry><guilabel>Summary</guilabel></entry>
     127                <entry>
     128                  <para>
     129                    <replaceable>$port</replaceable>
     130                    <replaceable>$version</replaceable>
     131                    <replaceable>[$variants]</replaceable>: <replaceable>short
     132                      problem summary</replaceable>
     133                  </para>
     134                  <para>
     135                    <emphasis role="strong">Example:</emphasis> openssl
     136                    @1.0.1e_1+universal: DTLS handshake error messages with
     137                    openconnect
     138                  </para>
     139                </entry>
     140              </row>
     141              <row>
     142                <entry><guilabel>Description</guilabel></entry>
     143                <entry>
     144                  Describe your problem. Preformatted text (such as terminal
     145                  output) should be put in <literal>{{{<replaceable>three curly
     146                      brackets</replaceable>}}}</literal>. Please attach large
     147                  amounts of output rather than pasting. Use the preview
     148                  button!
     149                </entry>
     150              </row>
     151              <row>
     152                <entry><guilabel>Type</guilabel></entry>
     153                <entrytbl cols="2" colsep="0" rowsep="0">
     154                  <tbody>
     155                    <row>
     156                      <entry><guimenu>defect</guimenu></entry>
     157                      <entry>Bugs, build failures, documentation fixes</entry>
     158                    </row>
     159                    <row>
     160                      <entry><guimenu>enhancement</guimenu></entry>
     161                      <entry>Improving existing work</entry>
     162                    </row>
     163                    <row>
     164                      <entry><guimenu>update</guimenu></entry>
     165                      <entry>Update requests or patch submissions for ports</entry>
     166                    </row>
     167                    <row>
     168                      <entry><guimenu>submissions</guimenu></entry>
     169                      <entry>Submission of new <filename>Portfile</filename>s</entry>
     170                    </row>
     171                    <row>
     172                      <entry><guimenu>request</guimenu></entry>
     173                      <entry>Requests for new ports</entry>
     174                    </row>
     175                  </tbody>
     176                </entrytbl>
     177              </row>
     178              <row>
     179                <entry><guilabel>Priority</guilabel></entry>
     180                <entry>
     181                  Use <guimenu>normal</guimenu> or <guimenu>low</guimenu>.
     182                  <guimenu>High</guimenu> is reserved for MacPorts developers.
     183                </entry>
     184              </row>
     185              <row>
     186                <entry><guilabel>Milestone</guilabel></entry>
     187                <entry>Leave empty.</entry>
     188              </row>
     189              <row>
     190                <entry><guilabel>Component</guilabel></entry>
     191                <entrytbl cols="2" colsep="0" rowsep="0">
     192                  <tbody>
     193                    <row>
     194                      <entry><guimenu>base</guimenu></entry>
     195                      <entry>Tickets affecting MacPorts itself</entry>
     196                    </row>
     197                    <row>
     198                      <entry><guimenu>guide</guimenu></entry>
     199                      <entry>Use for documentation</entry>
     200                    </row>
     201                    <row>
     202                      <entry><guimenu>ports</guimenu></entry>
     203                      <entry>Tickets affecting specific ports. Remember to set
     204                        the <guilabel>port</guilabel> field!</entry>
     205                    </row>
     206                    <row>
     207                      <entry><guimenu>server/hosting</guimenu></entry>
     208                      <entry>Use for infrastructure issues</entry>
     209                    </row>
     210                    <row>
     211                      <entry><guimenu>website</guimenu></entry>
     212                      <entry>Enhancements and fixes for the web site</entry>
     213                    </row>
     214                    <row>
     215                      <entry><guimenu>wiki</guimenu></entry>
     216                      <entry>Enhancements and fixes for the wiki (or just edit
     217                        it directly!)</entry>
     218                    </row>
     219                  </tbody>
     220                </entrytbl>
     221              </row>
     222              <row>
     223                <entry><guilabel>Version</guilabel></entry>
     224                <entry>The version of MacPorts you are running.</entry>
     225              </row>
     226              <row>
     227                <entry><guilabel>Keywords</guilabel></entry>
     228                <entry><literal>maintainer</literal> if you are the port's
     229                  maintainer. <literal>haspatch</literal> if you are attaching
     230                  a patch. <ulink url="https://trac.macports.org/wiki/TicketsKeywordGuidelines">Full
     231                    list</ulink>.
     232                </entry>
     233              </row>
     234              <row>
     235                <entry><guilabel>Port</guilabel></entry>
     236                <entry>The name of the port affected by this ticket. Separate
     237                  multiple using spaces. Leave empty for non-port
     238                  tickets.</entry>
     239              </row>
     240              <row>
     241                <entry><guilabel>Owner</guilabel>/<guilabel>Cc</guilabel></entry>
     242                <entry>Full email address of the port's maintainer. Run
     243                  <command>port info --maintainer
     244                    <replaceable>&lt;portname&gt;</replaceable></command> to
     245                  look this up. Do not add
     246                  <email>nomaintainer@macports.org</email> or
     247                  <email>openmaintainer@macports.org</email>. For ports with
     248                  multiple maintainers, only put the first maintainer into the
     249                  <guilabel>Owner</guilabel> field and all others in the
     250                  <guilabel>Cc</guilabel> field. You do not need to Cc
     251                  yourself.</entry>
     252              </row>
     253            </tbody>
     254          </tgroup>
     255        </informaltable>
     256      </tip>
     257
    111258      <para>There are certain conventions used to ensure that Trac tickets
    112259      convey as much accurate information as possible so problems and
     
    251398            <listitem>
    252399              <para><guimenu>server/hosting</guimenu> - For MacPorts hosting
    253               &amp; server-side issues, reserved for MacPorts PortMgr team
    254               members.</para>
     400              &amp; server-side issues.</para>
    255401            </listitem>
    256402
     
    281427          maintainer, or <quote>LP64</quote> if reporting an issue that only
    282428          affects 64-bit platforms.</para>
     429
     430          <para>See
     431            <ulink url="https://trac.macports.org/wiki/TicketsKeywordGuidelines">the
     432              TicketsKeywordGuidelines wiki page</ulink> for a clickable list
     433            of all keywords.</para>
    283434        </listitem>
    284435
Note: See TracChangeset for help on using the changeset viewer.