git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Glen Choo <chooglen@google.com>
To: Junio C Hamano <gitster@pobox.com>, Bagas Sanjaya <bagasdotme@gmail.com>
Cc: git@vger.kernel.org, Johannes Schindelin <johannes.schindelin@gmx.de>
Subject: Re: [PATCH v3] Documentation: specify base point when generating MyFirstContribution patchset
Date: Mon, 18 Oct 2021 10:32:54 -0700	[thread overview]
Message-ID: <kl6lzgr6z1a1.fsf@chooglen-macbookpro.roam.corp.google.com> (raw)
In-Reply-To: <xmqqzgr6w97p.fsf@gitster.g>


The fact that we are having this right/wrong base discussion makes me
think that including the base is out of scope for first time
contributors. 

> But that does not mean master would always be the right base, does
> it?  What if you had a work totally unrelated to the contents of
> this tutorial on the 'master' front?  The person on the receiving
> end may not even know what object it refers to until you pushed your
> 'master' branch out.

This is the crux of the problem, which is that the contributor's base is
actually their private 'master' branch, but their patches go to the
upstream 'master' branch. Does it even matter that the patches were
originally authored on a private 'master'?

If it matters, the 'master' should be part of the patchset or it can
be described using the conventions of the list ("this series is based
off a merge of ab/foo-bar and cd/baz").

If it does not matter, then providing the base is not helpful.

I suspect that we are documenting --base is that we do not have *any*
documentation of this in our mailing list workflow docs, and
MyFirstContribution is becoming a catch-all for all of our workflow
regardless of whether it is truly for first-timers or not. My own docs
changes [1] are arguably guilty of doing the same thing.

As you mentioned in the v2 thread:

  Actually it is up to contributors whether they want to include `--base` 
  or not.

This is a level of discretion that we shouldn't be leaving to first
timers (as a very recent first timer, I would not appreciate this
ambiguity). This document should be recommending good, easy-to-follow
defaults for first timers, thus I think that discretionary things belong
elsewhere.

We might consider adding _yet another_ document designed for
levelling up contributors past their first contribution, something along
the lines of "Patch submission tips and tricks". This could hold
information that we want contributors to know about, but are not
necessary for a first-timer e.g. --range-diff and --base.

[1] https://lore.kernel.org/git/20210922202218.7986-1-chooglen@google.com/

  reply	other threads:[~2021-10-18 17:32 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-18 12:41 [PATCH v3] Documentation: specify base point when generating MyFirstContribution patchset Bagas Sanjaya
2021-10-18 17:09 ` Junio C Hamano
2021-10-18 17:32   ` Glen Choo [this message]
2021-10-18 20:08     ` Re* " Junio C Hamano
2021-10-19  4:36       ` Eric Sunshine

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=kl6lzgr6z1a1.fsf@chooglen-macbookpro.roam.corp.google.com \
    --to=chooglen@google.com \
    --cc=bagasdotme@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=johannes.schindelin@gmx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).