[erlang-questions] FOP (was: Re: Trace-Driven Development)

[Tim McNamara]

The reason that it is "not neat" is your focus is on side issues. The
real issue is how to make the contributing as simple as possible, thus
leading to better documentation. Expecting people to download the
entire source distribution to fix minor grammar mistakes is far less
neat.

Concerns about column widths are really not that significant.

"patch-1" is good enough for a branch name, merely because it
basically implies that it is a minor change that came through the
GitHub web UI. No one else would use such a convention. Branch names
are far less significant than commit messages, which are strongly
promoted within GitHub's interface.

Pull request policies are just policies. If the OTP team would prefer
a patch file, they simply change the file extension of the URL and
they have a patch file.


On 7 June 2012 22:18, Anthony Ramine <n.oxyde@REDACTED> wrote:
> Editing directly from GitHub makes you unable to check that you wrote lines
> too long (under 80 columns).
> Also it produces nondescript branch names like "patch-1".
>
> Furthermore, Erlang/OTP explicitely forbid pull requests for contribution.
>
> For all these points, I would say it's not neat at all.
>
> --
> Anthony Ramine
>
> Le 7 juin 2012 à 12:06, H. Diedrich a écrit :
>
> I think github-online editing worked, quite nicely even.
>
> The process seems tedious but what you get for free is quite nice.
>
> https://github.com/erlang/otp/pull/24
>
> You  click "edit this file", it creates a github fork for you.
> When you change and click "save" the changes are saved to your fork.
> Then you are automatically put on the screen where you send a pull request.
> As for example the link above.
>
> Pretty neat in my view. Absolutely usable so far. A fully documented and
> repository-based, click-and-point patching process.
>
> Henning
>
> Magnus Henoch schrieb:
>
> ----- Original Message -----
>
>
> On 7 June 2012 12:23, OvermindDL1 <overminddl1@REDACTED> wrote:
>
>
> On Wed, Jun 6, 2012 at 7:50 AM, Michael Turner
> <michael.eugene.turner@REDACTED> wrote:
>
>
> and nobody
> bothers to correct the mistakes.
>
>
> Not "nobody". For example, I'm one of those weird people who will
> spend 30 seconds to sign up for almost any wiki I see a typo in.
>
>
> For what it is worth, I am one as well.  Some sort of user-editable
> documentation (even something that I could comment on like the
> Haskell
> one) would be nice.
>
>
> One very easy to implement solution would be to put the sources of
> the
> document into GitHub and use pull requests. This is especially handy
> these days, given that GitHub supports in-browser editing.
>
>
> So I decided to try this out.  I went to
> https://github.com/erlang/otp/blob/maint/lib/et/doc/src/et_intro.xml ,
> clicked "Edit this file", removed the stray apostrophe on line 43,
> typed in a commit message, and clicked "Propose file change".  I got
> a very fancy 500 error page that changes perspective when I move the
> mouse; no sign of anything being committed to my otp fork on Github.
>
> Is there a workaround for that?
>
> Regards,
>
>
>
> _______________________________________________
> erlang-questions mailing list
> erlang-questions@REDACTED
> http://erlang.org/mailman/listinfo/erlang-questions
>
>
>
> _______________________________________________
> erlang-questions mailing list
> erlang-questions@REDACTED
> http://erlang.org/mailman/listinfo/erlang-questions
>