All of lore.kernel.org
 help / color / mirror / Atom feed
From: Kent Gibson <warthog618@gmail.com>
To: linux-gpio@vger.kernel.org, brgl@bgdev.pl
Cc: Kent Gibson <warthog618@gmail.com>
Subject: [libgpiod][PATCH] README: provide more info in Contributing
Date: Sat, 20 May 2023 11:11:50 +0800	[thread overview]
Message-ID: <20230520031150.20062-1-warthog618@gmail.com> (raw)

Add more detail to Contributing to make it easier for new users to
contribute.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
I was tempted to add something on formatting with clang-format, but I'm
not 100% clear on the formatting policy myself.
Would be nice for that to be clarified.

 README | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/README b/README
index b71739e..8e726fe 100644
--- a/README
+++ b/README
@@ -275,8 +275,16 @@ were selected and help2man is available in the system.
 CONTRIBUTING
 ------------
 
-Contributions are welcome - please send patches and bug reports to
-linux-gpio@vger.kernel.org (add the [libgpiod] prefix to the e-mail subject
-line) and stick to the linux kernel coding style when submitting new code.
+Contributions are welcome - please send questions, patches and bug reports
+to linux-gpio@vger.kernel.org (add the [libgpiod] prefix to the e-mail
+subject line).  Note that the mailing list quietly drops HTML formatted
+e-mail, so be sure to send plain text[2].
+
+Code submissions should stick to the linux kernel coding style[3] and
+follow the kernel patch submission process[4] as applied to the libgpiod
+source tree.
 
 [1] https://github.com/bats-core/bats-core
+[2] https://docs.kernel.org/process/email-clients.html
+[3] https://docs.kernel.org/process/coding-style.html
+[4] https://docs.kernel.org/process/submitting-patches.html
-- 
2.40.1


             reply	other threads:[~2023-05-20  3:12 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-20  3:11 Kent Gibson [this message]
2023-05-22 16:29 ` [libgpiod][PATCH] README: provide more info in Contributing Bartosz Golaszewski
2023-05-23  2:21   ` Kent Gibson
2023-05-23  7:41     ` Bartosz Golaszewski
2023-05-23  8:02       ` Bartosz Golaszewski

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=20230520031150.20062-1-warthog618@gmail.com \
    --to=warthog618@gmail.com \
    --cc=brgl@bgdev.pl \
    --cc=linux-gpio@vger.kernel.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.