From: Bartosz Golaszewski <brgl@bgdev.pl>
To: Vincent Fazio <vfazio@gmail.com>,
Kent Gibson <warthog618@gmail.com>,
Linus Walleij <linus.walleij@linaro.org>
Cc: linux-gpio@vger.kernel.org,
Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
Subject: [libgpiod][PATCH] README: add mentions on shellcheck and reuse
Date: Thu, 13 Jun 2024 16:01:17 +0200 [thread overview]
Message-ID: <20240613140117.39048-1-brgl@bgdev.pl> (raw)
From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
Extend the "Contributing" section of the README to include mentions of
shell scripts having to pass the `shellcheck` test and the entire tree
having to conform to `reuse lint` requirements.
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
---
README | 22 +++++++++++++---------
1 file changed, 13 insertions(+), 9 deletions(-)
diff --git a/README b/README
index 7a92a49..a6f24d1 100644
--- a/README
+++ b/README
@@ -284,7 +284,9 @@ to send plain text[3].
Code submissions should stick to the linux kernel coding style[4] and
follow the kernel patch submission process[5] as applied to the libgpiod
-source tree.
+source tree. All shell scripts must pass `shellcheck` tests[9]. All files
+must have a license and copyright SPDX headers and the repo is expected to
+pass the `reuse lint` check[10].
The mailing list archive[6] contains all the historical mails to the list,
and is the place to check to ensure your e-mail has been received.
@@ -300,11 +302,13 @@ tarballs should be fetched from kernel.org[8].
For more information, refer to CONTRIBUTING.md in this repository.
-[1] https://github.com/kward/shunit2
-[2] http://vger.kernel.org/vger-lists.html#linux-gpio
-[3] https://docs.kernel.org/process/email-clients.html
-[4] https://docs.kernel.org/process/coding-style.html
-[5] https://docs.kernel.org/process/submitting-patches.html
-[6] https://lore.kernel.org/linux-gpio/
-[7] https://github.com/brgl/libgpiod
-[8] https://mirrors.edge.kernel.org/pub/software/libs/libgpiod/
+[1] https://github.com/kward/shunit2
+[2] http://vger.kernel.org/vger-lists.html#linux-gpio
+[3] https://docs.kernel.org/process/email-clients.html
+[4] https://docs.kernel.org/process/coding-style.html
+[5] https://docs.kernel.org/process/submitting-patches.html
+[6] https://lore.kernel.org/linux-gpio/
+[7] https://github.com/brgl/libgpiod
+[8] https://mirrors.edge.kernel.org/pub/software/libs/libgpiod/
+[9] https://www.shellcheck.net/
+[10] https://reuse.software/
--
2.43.0
next reply other threads:[~2024-06-13 14:01 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-06-13 14:01 Bartosz Golaszewski [this message]
2024-06-13 14:25 ` [libgpiod][PATCH] README: add mentions on shellcheck and reuse Vincent Fazio
2024-06-13 14:41 ` Bartosz Golaszewski
2024-06-14 7:21 ` 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=20240613140117.39048-1-brgl@bgdev.pl \
--to=brgl@bgdev.pl \
--cc=bartosz.golaszewski@linaro.org \
--cc=linus.walleij@linaro.org \
--cc=linux-gpio@vger.kernel.org \
--cc=vfazio@gmail.com \
--cc=warthog618@gmail.com \
/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