[ghc-steering-committee] Redid our documentation

Tue Feb 28 11:58:14 UTC 2017

Joachim,

The new organisation at https://github.com/ghc-proposals/ghc-proposals is so much better.  Thank you!

How can I edit it in cosmetic ways?  I see no edit button.  (Defeated by github again.)

I agree that we should assign a shepherd when the owner submits a proposal to the committee.  Of course committee members can (and I hope will) get involved earlier.

Simon

From: ghc-steering-committee [mailto:ghc-steering-committee-bounces at haskell.org] On Behalf Of Simon Marlow
Sent: 27 February 2017 10:48
To: Joachim Breitner <mail at joachim-breitner.de>
Cc: ghc-steering-committee at haskell.org
Subject: Re: [ghc-steering-committee] Redid our documentation

I like the new organisation.  One functional difference I noticed: the new description says that we assign a shepherd when the proposal starts the review process, but under the existing process a shepherd is assigned to each proposal when the PR is created (but I guess we haven't been sticking to this?).  Ideally I think we'd assign shepherds earlier because it will streamline the review process: the shepherd will spot things that should be clarified or addressed before the rest of the committee gets involved.  I think it's likely to be a better use of resources.

This also addresses the question about labels: if each proposal has a shepherd, then the shepherd will notice when the proposer adds a comment to the PR requesting review, and can formally start the process with the rest of the committee.

Cheers
Simon

On 26 February 2017 at 04:26, Joachim Breitner <mail at joachim-breitner.de<mailto:mail at joachim-breitner.de>> wrote:
[I sent this mail from Monday to the wrong address, second try]

Hi,

there was a bit confusion about our documentation, so with SPJ’s
blessing I went ahead and restructured it a bit. For now, this is only
on a branch and not live yet:

https://github.com/ghc-proposals/ghc-proposals/tree/wip/docs-restructur<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fghc-proposals%2Fghc-proposals%2Ftree%2Fwip%2Fdocs-restructur&data=02%7C01%7Csimonpj%40microsoft.com%7Cc3454ff11b474b5813a108d45efe20c3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636237892968379132&sdata=sM402v4a3DgfMjmvUADYzPLWEMgEbCMzHwrlS8Gs7kk%3D&reserved=0>
ing

Note that it starts with a concise timeline of a proposal, and from
there has links to section answering specific questions, within the
same file. What was three files before (README, process, committee) is
now all in here (with the exception of the “detailed instructions” for
the Github-novice, which is in a separate file). This should make it
easier for everyone involved to know who has to do what when.

Our process is, however, flawed: We ask authors to set labels (“Under
Discussion” and “Under Committee Review”), but they do not have
permissions to do so. So this does not quite work.

So I suggest the following change:

 * What was “Under Discussion” is now simply any PR that does not have
any other label. This way, when opening discussion, nothing concrete
has to be done. Which is easier. (GitHub allows to list all PRs that
have no label, so there is no loss in functionality here.)

 * When the author wants to submit the PR, he sends a mail to this
mailinglist (is this set up to accept mails from non-subscribers?) and
it its the task of the shephard to set the label to indicate that that
the committee has accepted to review the proposal. (At this point, the
shephard could for example set the `Out-of-scope` label instead.)

If there are no complains I will adjust the docs-restructuring branch
accordingly and then move that to master.

Greetings,
Joachim

--
Joachim “nomeata” Breitner
  mail at joachim-breitner.de<mailto:mail at joachim-breitner.de> • https://www.joachim-breitner.de/<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.joachim-breitner.de%2F&data=02%7C01%7Csimonpj%40microsoft.com%7Cc3454ff11b474b5813a108d45efe20c3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636237892968535389&sdata=yVRoXu9qb%2BYvutm%2FGb%2FzFd04NMr7taMaVFIzLz4P9wQ%3D&reserved=0>
  XMPP: nomeata at joachim-breitner.de<mailto:nomeata at joachim-breitner.de> • OpenPGP-Key: 0xF0FBF51F
  Debian Developer: nomeata at debian.org<mailto:nomeata at debian.org>
_______________________________________________
ghc-steering-committee mailing list
ghc-steering-committee at haskell.org<mailto:ghc-steering-committee at haskell.org>
https://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-steering-committee<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fmail.haskell.org%2Fcgi-bin%2Fmailman%2Flistinfo%2Fghc-steering-committee&data=02%7C01%7Csimonpj%40microsoft.com%7Cc3454ff11b474b5813a108d45efe20c3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636237892968535389&sdata=w84hmRquM4%2BcK47yt43tAgl8iyzIcK7BoCht2FiLaSs%3D&reserved=0>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-steering-committee/attachments/20170228/53267615/attachment-0001.html>