public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
From: Leo Liang <ycliang@andestech.com>
To: u-boot@lists.denx.de
Subject: Cover Letter of Patchsets
Date: Mon, 6 Jul 2020 10:35:10 +0800	[thread overview]
Message-ID: <20200706023510.GB2522@andestech.com> (raw)

Hi Tom,

I am Leo, just recently joined the community.
and been picking up the guide line of uboot's development.

I am a bit curious about the policy on the cover letter of patchsets.
Is cover letter mandatory ?

IMHO, making it mandatory, especially on patchsets that consist of more than 1 patch, is more than useful and of great advantages.

1. Making patches clearer for peer and maintainer review
   
   The reviewer and maintainer could immediately understand,
   or at least get the idea of, the whole patchset
   through only reading this ONE cover letter
   without having to dive into each of the patch.

   And thus quickly determine if the patchset solves the problem
   or if the patchset is well organized.

2. Helping the author better organize the patchset
   
   Writing the cover letter would require the author 
   to scrutinize the patchset structure again,
   in order to elaborate his/her craft.

   So when composing the letter, the relevance of each patch
   would be thoroghly looked over and the patchset might be
   refined into small but more closely-related patchsets.

   And it would be easier for the maintainer to pull small gradual changes 
   than a huge patchset with lots of changes at once.
   

In all, I think it would be nice to write cover letter to introduce the work.

If I miss anything or misunderstand anything please let me know, thanks in advance.

Best regards,
Leo

             reply	other threads:[~2020-07-06  2:35 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-06  2:35 Leo Liang [this message]
2020-07-06 12:03 ` Cover Letter of Patchsets Wolfgang Denk
2020-07-07  1:32   ` Leo Liang

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

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

  git send-email \
    --in-reply-to=20200706023510.GB2522@andestech.com \
    --to=ycliang@andestech.com \
    --cc=u-boot@lists.denx.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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox