1
0
mirror of https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git synced 2026-10-24 00:48:53 +03:00
Files
libgpiod/docs/contributing.rst
Bartosz Golaszewski dda57bd63f doc: move README contents to sphinx docs
We now have comprehensive documentation available online on readthedocs.
Let's not duplicate docs in README - move all information into the
sphinx files.

While at it: make the remaining README use markdown.

Reviewed-by: Vincent Fazio <vfazio@xes-inc.com>
Link: https://lore.kernel.org/r/20250211-improve-docs-v4-17-dc56702c2ca8@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
2025-02-17 09:18:27 +01:00

1.9 KiB

Contributing

Contributions are welcome - please send questions, patches and bug reports to the linux-gpio mailing list by e-mailing 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.

Code submissions should stick to the linux kernel coding style and follow the kernel patch submission process as applied to the libgpiod source tree. All shell scripts must pass shellcheck tests. All files must have a license and copyright SPDX headers and the repo is expected to pass the reuse lint check.

The mailing list archive contains all the historical mails to the list, and is the place to check to ensure your e-mail has been received. Search for "libgpiod" to filter the list down to relevant messages. Those also provide examples of the expected formatting. Allow some time for your e-mail to propagate to the list before retrying, particularly if there are no e-mails in the list more recent than yours.

There is a libgpiod github page available for reporting bugs and general discussions and although PRs can be submitted and discussed, upstreambound patches need to go through the mailing list nevertheless.

Note

For more information, please refer to the CONTRIBUTING.md file in the libgpiod source tree.