<pre style='margin:0'>
Perry E. Metzger (pmetzger) pushed a commit to branch master
in repository macports-guide.
</pre>
<p><a href="https://github.com/macports/macports-guide/commit/4cc9f2402ce307f23d5c0f54d61bd4b9561d7fcf">https://github.com/macports/macports-guide/commit/4cc9f2402ce307f23d5c0f54d61bd4b9561d7fcf</a></p>
<pre style="white-space: pre; background: #F8F8F8">The following commit(s) were added to refs/heads/master by this push:
<span style='display:block; white-space:pre;color:#404040;'> new 4cc9f24 Emphasize GitHub PRs over Trac tickets for new ports and patches
</span>4cc9f24 is described below
<span style='display:block; white-space:pre;color:#808000;'>commit 4cc9f2402ce307f23d5c0f54d61bd4b9561d7fcf
</span>Author: Perry E. Metzger <perry@piermont.com>
AuthorDate: Wed Apr 11 11:18:35 2018 -0400
<span style='display:block; white-space:pre;color:#404040;'> Emphasize GitHub PRs over Trac tickets for new ports and patches
</span><span style='display:block; white-space:pre;color:#404040;'>
</span><span style='display:block; white-space:pre;color:#404040;'> Add text explaining that PRs get faster treatment.
</span><span style='display:block; white-space:pre;color:#404040;'> In lists, move items for PRs ahead of items for Trac tickets.
</span><span style='display:block; white-space:pre;color:#404040;'> Suggest maintainers need both email and a github handle (current practice).
</span><span style='display:block; white-space:pre;color:#404040;'> Where there is text mentioning asking on -dev for action on tickets,
</span><span style='display:block; white-space:pre;color:#404040;'> also suggest asking there for action on pull requests.
</span><span style='display:block; white-space:pre;color:#404040;'> Suggest PRs for assuming maintainership as preferred to Trac tickets
</span><span style='display:block; white-space:pre;color:#404040;'>
</span><span style='display:block; white-space:pre;color:#404040;'> This probably could use more polish, and it would be good to look at
</span><span style='display:block; white-space:pre;color:#404040;'> similar cases throughout the document.
</span>---
guide/xml/project.xml | 67 ++++++++++++++++++++++++++++++++++++---------------
1 file changed, 47 insertions(+), 20 deletions(-)
<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/xml/project.xml b/guide/xml/project.xml
</span><span style='display:block; white-space:pre;color:#808080;'>index 5ebb2c5..c5e93a4 100644
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/xml/project.xml
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/xml/project.xml
</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -500,6 +500,16 @@
</span> in which case no Trac ticket is required.
</para>
<span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <emphasis>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ The GitHub pull request method is strongly preferred over
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ submitting Trac tickets.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Submitting a Pull Request will likely result in your
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ contribution being merged into MacPorts much faster, as the
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ workflow is much easier for the maintainers.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </emphasis>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span> <!-- Should we have similar sections about committing to base sources and
documentation, or alternatively add this to the following? -->
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -519,7 +529,12 @@
</span> </listitem>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>Either create a Trac ticket ...</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Either submit the new port through
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <link xlink:href="https://github.com/macports/macports-ports/pulls">a pull request on GitHub</link>...</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>...or create a Trac ticket.</para>
</span> <orderedlist>
<listitem>
<para>Set the type to <guilabel>submission</guilabel>.</para>
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -541,10 +556,6 @@
</span> </listitem>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>... or submit the new port through a pull request on GitHub.</para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <listitem>
</span> <para>If your ticket or pull request doesn't receive any attention within a few days
you may send an email to
<email>macports-dev@lists.macports.org</email> and request a
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -579,7 +590,12 @@
</span> </listitem>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>Either create a Trac ticket ...</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Either submit the port update through
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <link xlink:href="https://github.com/macports/macports-ports/pulls">a pull request on GitHub</link>...</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>...or create a Trac ticket.</para>
</span> <orderedlist>
<listitem>
<para>Set the type to <guilabel>enhancement</guilabel> for
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -614,10 +630,6 @@
</span> </listitem>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>... or submit the port update through a pull request on GitHub.</para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <listitem>
</span> <para>If your ticket or pull request doesn't receive any attention within a few days
you may send an email to
<email>macports-dev@lists.macports.org</email> and request a
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -636,7 +648,7 @@
</span>
<itemizedlist>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>An email address or a GitHub account.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>An email address and a GitHub account.</para>
</span> </listitem>
<listitem>
<para>A copy of the <filename>Portfile</filename>. Do not worry if
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -657,8 +669,10 @@
</span> <para>You do <emphasis>not</emphasis> need:</para>
<itemizedlist>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>Commit access to the MacPorts repository. Instead, you create
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- patches and open tickets in Trac. You can, however, <link
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Commit access to the MacPorts repository. Instead, you
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ open pull requests in GitHub
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ (or create patches and open tickets in Trac.)
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ You can, however, <link
</span> linkend="project.membership">apply for commit access</link>
once you have some experience in maintaining ports. In fact, we
would like to encourage you to apply after a few months.</para>
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -829,9 +843,17 @@ To use the current port, you must be in a port's directory.</screen>
</span> </listitem>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>If you are only changing the maintainer, <link
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>If you are only changing the maintainer,
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <link
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ xlink:href="https://github.com/macports/macports-ports/pulls">file
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ a pull request on GitHub</link>.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>You may also
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <link
</span> xlink:href="https://trac.macports.org/newticket">file a new ticket in
<span style='display:block; white-space:pre;background:#ffe0e0;'>- Trac</link>. Set <guilabel>type</guilabel> to
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Trac</link> to change the maintainer, though GitHub pull requests are preferred.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Set <guilabel>type</guilabel> to
</span> <guilabel>enhancement</guilabel>. Leave the
<guilabel>milestone</guilabel> field empty. If you added yourself
as co-maintainer, add the other maintainers in the
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -841,8 +863,11 @@ To use the current port, you must be in a port's directory.</screen>
</span> a patch), check the box that you want to attach files to the ticket
and submit. After submission, attach the patch you created in the
previous step.</para>
<span style='display:block; white-space:pre;background:#e0ffe0;'>+ </listitem>
</span>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>If you are also fixing a bug, attach a separate patch for that
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>If you are also fixing a bug, make a separate commit
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ for that in your pull request, or attach a separate patch for that
</span> change to the same ticket. If you are fixing a bug that already has
a ticket, attach a patch fixing the bug there and file the
maintainer change in a separate ticket (with a separate patch) as
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -856,15 +881,17 @@ To use the current port, you must be in a port's directory.</screen>
</span> </listitem>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>If your ticket doesn't receive any attention within a few days
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>If your pull request or ticket doesn't receive any attention within a few days
</span> you may send an email to
<email>macports-dev@lists.macports.org</email> and request
<span style='display:block; white-space:pre;background:#ffe0e0;'>- a review and/or commit. Please include a link to the ticket.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ a review and/or commit. Please include a link to the pull
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ request or ticket.</para>
</span> </listitem>
</orderedlist>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>Once you are the maintainer for a port, all new tickets for this
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- port will be assigned to you. You are expected to take a look at these
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Once you are the maintainer for a port, all new pull requests
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ and tickets for this port will be assigned to you.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ You are expected to take a look at these pull requests and
</span> tickets, give advice and try to debug problems. If you are stuck, do
not hesitate to ask on the
<email>macports-dev@lists.macports.org</email> list.</para>
</pre><pre style='margin:0'>
</pre>