<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[153048] trunk/doc-new/guide/xml/project.xml</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="https://trac.macports.org/changeset/153048">153048</a></dd>
<dt>Author</dt> <dd>cal@macports.org</dd>
<dt>Date</dt> <dd>2016-09-22 14:38:01 -0700 (Thu, 22 Sep 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>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</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkdocnewguidexmlprojectxml">trunk/doc-new/guide/xml/project.xml</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkdocnewguidexmlprojectxml"></a>
<div class="modfile"><h4>Modified: trunk/doc-new/guide/xml/project.xml (153047 => 153048)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/doc-new/guide/xml/project.xml 2016-09-22 21:34:58 UTC (rev 153047)
+++ trunk/doc-new/guide/xml/project.xml 2016-09-22 21:38:01 UTC (rev 153048)
</span><span class="lines">@@ -108,6 +108,153 @@
</span><span class="cx"> <section id="project.tickets.guidelines">
</span><span class="cx"> <title>Trac Ticket Guidelines</title>
</span><span class="cx">
</span><ins>+ <para>This is a short overview of the guidelines for Trac tickets. Please
+ see below for longer and more detailed explanations.</para>
+
+ <tip>
+ <title>TL;DR</title>
+ <informaltable frame="none">
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Field</entry>
+ <entry>Content</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><guilabel>Summary</guilabel></entry>
+ <entry>
+ <para>
+ <replaceable>$port</replaceable>
+ <replaceable>$version</replaceable>
+ <replaceable>[$variants]</replaceable>: <replaceable>short
+ problem summary</replaceable>
+ </para>
+ <para>
+ <emphasis role="strong">Example:</emphasis> openssl
+ @1.0.1e_1+universal: DTLS handshake error messages with
+ openconnect
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry><guilabel>Description</guilabel></entry>
+ <entry>
+ Describe your problem. Preformatted text (such as terminal
+ output) should be put in <literal>{{{<replaceable>three curly
+ brackets</replaceable>}}}</literal>. Please attach large
+ amounts of output rather than pasting. Use the preview
+ button!
+ </entry>
+ </row>
+ <row>
+ <entry><guilabel>Type</guilabel></entry>
+ <entrytbl cols="2" colsep="0" rowsep="0">
+ <tbody>
+ <row>
+ <entry><guimenu>defect</guimenu></entry>
+ <entry>Bugs, build failures, documentation fixes</entry>
+ </row>
+ <row>
+ <entry><guimenu>enhancement</guimenu></entry>
+ <entry>Improving existing work</entry>
+ </row>
+ <row>
+ <entry><guimenu>update</guimenu></entry>
+ <entry>Update requests or patch submissions for ports</entry>
+ </row>
+ <row>
+ <entry><guimenu>submissions</guimenu></entry>
+ <entry>Submission of new <filename>Portfile</filename>s</entry>
+ </row>
+ <row>
+ <entry><guimenu>request</guimenu></entry>
+ <entry>Requests for new ports</entry>
+ </row>
+ </tbody>
+ </entrytbl>
+ </row>
+ <row>
+ <entry><guilabel>Priority</guilabel></entry>
+ <entry>
+ Use <guimenu>normal</guimenu> or <guimenu>low</guimenu>.
+ <guimenu>High</guimenu> is reserved for MacPorts developers.
+ </entry>
+ </row>
+ <row>
+ <entry><guilabel>Milestone</guilabel></entry>
+ <entry>Leave empty.</entry>
+ </row>
+ <row>
+ <entry><guilabel>Component</guilabel></entry>
+ <entrytbl cols="2" colsep="0" rowsep="0">
+ <tbody>
+ <row>
+ <entry><guimenu>base</guimenu></entry>
+ <entry>Tickets affecting MacPorts itself</entry>
+ </row>
+ <row>
+ <entry><guimenu>guide</guimenu></entry>
+ <entry>Use for documentation</entry>
+ </row>
+ <row>
+ <entry><guimenu>ports</guimenu></entry>
+ <entry>Tickets affecting specific ports. Remember to set
+ the <guilabel>port</guilabel> field!</entry>
+ </row>
+ <row>
+ <entry><guimenu>server/hosting</guimenu></entry>
+ <entry>Use for infrastructure issues</entry>
+ </row>
+ <row>
+ <entry><guimenu>website</guimenu></entry>
+ <entry>Enhancements and fixes for the web site</entry>
+ </row>
+ <row>
+ <entry><guimenu>wiki</guimenu></entry>
+ <entry>Enhancements and fixes for the wiki (or just edit
+ it directly!)</entry>
+ </row>
+ </tbody>
+ </entrytbl>
+ </row>
+ <row>
+ <entry><guilabel>Version</guilabel></entry>
+ <entry>The version of MacPorts you are running.</entry>
+ </row>
+ <row>
+ <entry><guilabel>Keywords</guilabel></entry>
+ <entry><literal>maintainer</literal> if you are the port's
+ maintainer. <literal>haspatch</literal> if you are attaching
+ a patch. <ulink url="https://trac.macports.org/wiki/TicketsKeywordGuidelines">Full
+ list</ulink>.
+ </entry>
+ </row>
+ <row>
+ <entry><guilabel>Port</guilabel></entry>
+ <entry>The name of the port affected by this ticket. Separate
+ multiple using spaces. Leave empty for non-port
+ tickets.</entry>
+ </row>
+ <row>
+ <entry><guilabel>Owner</guilabel>/<guilabel>Cc</guilabel></entry>
+ <entry>Full email address of the port's maintainer. Run
+ <command>port info --maintainer
+ <replaceable>&lt;portname&gt;</replaceable></command> to
+ look this up. Do not add
+ <email>nomaintainer@macports.org</email> or
+ <email>openmaintainer@macports.org</email>. For ports with
+ multiple maintainers, only put the first maintainer into the
+ <guilabel>Owner</guilabel> field and all others in the
+ <guilabel>Cc</guilabel> field. You do not need to Cc
+ yourself.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </tip>
+
</ins><span class="cx"> <para>There are certain conventions used to ensure that Trac tickets
</span><span class="cx"> convey as much accurate information as possible so problems and
</span><span class="cx"> contributions may be acted upon efficiently.</para>
</span><span class="lines">@@ -250,8 +397,7 @@
</span><span class="cx">
</span><span class="cx"> <listitem>
</span><span class="cx"> <para><guimenu>server/hosting</guimenu> - For MacPorts hosting
</span><del>- &amp; server-side issues, reserved for MacPorts PortMgr team
- members.</para>
</del><ins>+ &amp; server-side issues.</para>
</ins><span class="cx"> </listitem>
</span><span class="cx">
</span><span class="cx"> <listitem>
</span><span class="lines">@@ -280,6 +426,11 @@
</span><span class="cx"> to the ticket, <quote>maintainer</quote> if you are the port's
</span><span class="cx"> maintainer, or <quote>LP64</quote> if reporting an issue that only
</span><span class="cx"> affects 64-bit platforms.</para>
</span><ins>+
+ <para>See
+ <ulink url="https://trac.macports.org/wiki/TicketsKeywordGuidelines">the
+ TicketsKeywordGuidelines wiki page</ulink> for a clickable list
+ of all keywords.</para>
</ins><span class="cx"> </listitem>
</span><span class="cx">
</span><span class="cx"> <listitem>
</span></span></pre>
</div>
</div>
</body>
</html>