git.net

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Druid PR review checklist


I don't think that would be convenient. I don't want to act as a gatekeeper
for every change and contribution to the doc.

On Tue, 13 Nov 2018, 19:34 Slim Bouguerra <bslim@xxxxxxxxxx wrote:

> Great Doc.
> Since the end goal is a .md document as part of the github repo.  How about
> you actually start a PR and with something like mark down document and
> peoples can interact with it via git comments, that will be better than
> google Docs thought.
>
> On Tue, Nov 13, 2018 at 10:25 AM Roman Leventov <leventov@xxxxxxxxxx>
> wrote:
>
> > Yes, definitely, that is what I was planning to do. Except that I would
> say
> > that it could take closer to a month to complete a document.
> >
> > On Tue, 13 Nov 2018, 18:56 Julian Hyde <jhyde@xxxxxxxxxx wrote:
> >
> > > Thanks for starting this thread, Roman. It’s a great discussion to be
> > > having.
> > >
> > > A word of caution about google docs. Since this one can be edited by
> > > anyone who has the link, and the link is posted in a public archive,
> then
> > > at some point this doc will fall victim to spam or vandalism. I suggest
> > > that after this discussion has died down (say a week or so?) you move
> the
> > > content to a more protected medium, say a GitHub PR, and remove the doc
> > or
> > > make it read-only.
> > >
> > > Julian
> > >
> > >
> > > > On Nov 12, 2018, at 2:42 PM, Roman Leventov <leventov@xxxxxxxxxx>
> > wrote:
> > > >
> > > > A lot of new committers are expected to enter the projects with
> rights
> > to
> > > > review and merge PRs.
> > > >
> > > > I suggest to create a PR review checklist to help new (and old!)
> > > reviewers
> > > > (and PR authors, for self-review before even publishing a PR) not to
> > > forget
> > > > something.
> > > >
> > > > I think a PR (because it's not editable by many people) or a Wiki
> page
> > > > (because it's not commentable) on Github is not an ideal form of
> > > > collaboration for creating an original version of such document, so I
> > > > created a Google document (commentable, editable):
> > > >
> > >
> >
> https://docs.google.com/document/d/17EEKT6fih9Dd5NfXjBoECcKbVp1eOB2vb3jKqTF9pPc/edit?usp=sharing
> > > >
> > > > Developers are welcome to add comments and list things that they look
> > at
> > > > when doing reviews.
> > > >
> > > > Note: the list is going to be huge and people are not realistically
> > > > expected to pedantically follow all of it's items on every PR review,
> > but
> > > > IMO such "gold standard" should help to keep the quality of reviews
> > high.
> > >
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: dev-unsubscribe@xxxxxxxxxxxxxxxx
> > > For additional commands, e-mail: dev-help@xxxxxxxxxxxxxxxx
> > >
> > >
> >
>