There seems to be some confusion about the online editing available through
Github. I think it's an awesome way to get new contributors to help out.
Let me explain.

Consider a github user who is not an admin of the Github PDLPorters group.
When they wish to edit a file and click the "Edit" button at the top of the
page, Github forks the main repository and creates a new pdl fork under the
user's account. Let me repeat, for non-admin users, online editing forks
the repo. Furthermore, the conclusion of the edit lets the user issue a
pull request. There is no way that code is getting into the PDLPorters
branch unless a PDLPorters admin accepts the pull request, which
automatically puts a developer in the loop.

Compared with emailing git patches, I think this is much easier for the
submitter and the reviewer and I believe that it should be the encouraged.

David


On Fri, Jan 25, 2013 at 8:14 AM, Joel Berger <[email protected]>wrote:

> In that case I agree. Fork/clone/edit/pull-req is the "killer-app" of
> github, and its the major reason I would hope that PDL development moves
> there. Online editing is somewhat more convenient, but I wouldn't start
> spreading it around since it cannot be tested.
>
> On Fri, Jan 25, 2013 at 8:05 AM, Chris Marshall <[email protected]>wrote:
>
>> My comment was with respect to your email
>> statement::
>>
>>   >> On Fri, Jan 25, 2013 at 8:33 AM, Joel Berger <
>> [email protected]>
>>   >> wrote:
>>   >> > If we are going to start proposing online edits (not
>> fork/clone/pull-req)...
>>
>> and not with respect to the current development
>> and git strategy.
>>
>> --Chris
>>
>> On Fri, Jan 25, 2013 at 9:01 AM, Joel Berger <[email protected]>
>> wrote:
>> > Chris, the edits don't get merged automatically unless you have commit.
>> > Otherwise they are sent as pull requests, for porters to
>> > review/comment/merge/reject.
>> >
>> >
>> > On Fri, Jan 25, 2013 at 7:58 AM, Chris Marshall <[email protected]
>> >
>> > wrote:
>> >>
>> >> I don't recommend online edits unless we can have
>> >> automated smokers for at least Mac OS X, linux, and
>> >> MSWin32 platforms.  Even then, I would prefer to have
>> >> "a developer in the loop" who can evaluate the status
>> >> of any changes as well as their potential risk.
>> >> Nothing derails development more than a broken
>> >> trunk.
>> >>
>> >> --Chris
>> >>
>> >> On Fri, Jan 25, 2013 at 8:33 AM, Joel Berger <[email protected]>
>> >> wrote:
>> >> > If we are going to start proposing online edits (not
>> >> > fork/clone/pull-req) we
>> >> > should setup a travis smoker, which will automatically run smoke
>> tests
>> >> > (but
>> >> > only on ubuntu). This prevents merging a non-tested non-runnable pull
>> >> > which
>> >> > is easier to happen from an online-only edit.
>> >> >
>> >> > Joel
>> >> >
>> >> > On Fri, Jan 25, 2013 at 6:42 AM, David Mertens
>> >> > <[email protected]>
>> >> > wrote:
>> >> >>
>> >> >> Lee -
>> >> >>
>> >> >> On Fri, Jan 25, 2013 at 1:44 AM, Lee <[email protected]> wrote:
>> >> >>>
>> >> >>> Thanks. I just tried logging in to SourceForge to put this (and
>> which)
>> >> >>> on
>> >> >>> the Perl for Matlab page, but although I am logged in to SF, there
>> is
>> >> >>> no
>> >> >>> edit link on the project page. Is this something for which I need
>> to
>> >> >>> apply?
>> >> >>>
>> >> >>> <snip>
>> >> >>
>> >> >>
>> >> >> SourceForge is where we keep the master repository for PDL, but it's
>> >> >> actually easier for new contributors to work through the mirrored
>> >> >> repository
>> >> >> on Github. The basic process is to edit the file online and submit a
>> >> >> pull
>> >> >> request. For your edits, I suggest that you
>> >> >>
>> >> >> create an account on Github if you don't already have one,
>> >> >> go to the page of the source file, in this case, here:
>> >> >> https://github.com/PDLPorters/pdl/blob/master/Basic/Pod/MATLAB.pod,
>> >> >> click the "Edit" button in the upper right of the page and make your
>> >> >> edits
>> >> >> (it's written in Perl's documentation format, called POD, in case it
>> >> >> looks
>> >> >> unusual),
>> >> >> describe in a couple of sentences what you changed in the "Extended
>> >> >> description" box at the bottom of the page and click "Propose File
>> >> >> Change",
>> >> >> on the New Pull Request page, click "Send Pull Request" (it'll copy
>> >> >> your
>> >> >> extended description as the description for the pull request, which
>> >> >> should
>> >> >> be fine here),
>> >> >> and finally, one of the PDL/Github folks will look at the pull
>> request
>> >> >> and
>> >> >> either pull it immediately or give feedback on how to improve it
>> before
>> >> >> it
>> >> >> gets pulled in.
>> >> >>
>> >> >> There are a couple of different directions to go from there, but we
>> >> >> need
>> >> >> not cover those details now. Give that a whirl and let us know how
>> it
>> >> >> goes,
>> >> >> and thanks for offering to clean up the Matlab docs!
>> >> >>
>> >> >> David
>> >> >>
>> >> >> --
>> >> >>  "Debugging is twice as hard as writing the code in the first place.
>> >> >>   Therefore, if you write the code as cleverly as possible, you are,
>> >> >>   by definition, not smart enough to debug it." -- Brian Kernighan
>> >> >>
>> >> >> _______________________________________________
>> >> >> Perldl mailing list
>> >> >> [email protected]
>> >> >> http://mailman.jach.hawaii.edu/mailman/listinfo/perldl
>> >> >>
>> >> >
>> >> >
>> >> > _______________________________________________
>> >> > Perldl mailing list
>> >> > [email protected]
>> >> > http://mailman.jach.hawaii.edu/mailman/listinfo/perldl
>> >> >
>> >
>> >
>>
>
>


-- 
 "Debugging is twice as hard as writing the code in the first place.
  Therefore, if you write the code as cleverly as possible, you are,
  by definition, not smart enough to debug it." -- Brian Kernighan
_______________________________________________
Perldl mailing list
[email protected]
http://mailman.jach.hawaii.edu/mailman/listinfo/perldl

Reply via email to