New guide section on Git and GitHub

[Andrew Moore]

As someone who only reads the manual as last resort, I think Section 7 of the MacPorts Guide could be retitled from “MacPorts Project” to “Contributing to MacPorts”.  And then steps for creating pull requests via GitHub spelled out tutorial-wise.  Perhaps steal an existing tutorial <https://yangsu.github.io/pull-request-tutorial/>.  But there are additional workflows and tricks like `git config receive.denyCurrentBranch updateInstead’ that might be worth sharing with contributors (the last trick is useful for syncing clones across multiple machines).

While I appreciate the intent, I think “easing into” GitHub is more obfuscating, and actually adds an extra hurdle for contributors.  For instance the section immediately following “Using Git and GitHub” is titled “New Ports” and proceeds with steps for contributing a Trac ticket.

Okay, so when all is said and done, am I actually prepared to make an actual contribution?  Perhaps it merits a topic of discussion for the online meeting how MacPorts wants to present itself.  I’d like to see one of MacPorts’s goals be towards non-profit status, and ultimately to attract the attention of Apple again.  Apple needs MacPorts desperately, they just don’t know it yet…
-AM
 

> On Apr 11, 2018, at 6:33 PM, Perry E. Metzger <pmetzger at macports.org> wrote:
> 
> On Wed, 11 Apr 2018 18:19:50 -0400 Andrew Moore <slewsys at gmail.com>
> wrote:
>> My impression from the mailing list is that going forward Trac
>> would be used exclusively for bug reports.  Any code submissions
>> would ideally be submitted as pull requests to GitHub.
> 
> That's both true and not quite true. I think ultimately we'll be
> going to that but for the moment we're easing in to it. The document
> currently says, in effect, "we strongly prefer GitHub pulls over Trac
> for code submissions."
> 
> I figure that ultimately it will indeed say "please
> only submit code by GitHub" but I don't think we have consensus on
> that yet. (If I'm wrong and we do have consensus, someone should feel
> free to make that even stronger in the document.)
> 
>> If so, this
>> change needs to put front and center, in large display type.
>> 
>> Section 7 “MacPorts Projects” should begin:  SUBMIT CODE AS GITHUB
>> PULL. REQUESTS.  IF YOU JUST WANT TO $#!@, PLEASE USE TRAC -AM
> 
> Perry
> -- 
> Perry E. Metzger		pmetzger at macports.org

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macports.org/pipermail/macports-dev/attachments/20180411/b3051f9a/attachment-0001.html>