[elbe-devel] [PATCH v2 2/2] README.adoc: Update Readme for updating bugs and contributions

Viraj Shah viraj.shah at linutronix.de
Wed Aug 3 17:43:55 CEST 2022


* Having a particular standard while reporting issue would help in
  resolving them. Let's develop these standards.

* Add know-how for contributing patches.

Signed-off-by: Viraj Shah <viraj.shah at linutronix.de>
---
 README.adoc | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.adoc b/README.adoc
index 4cd7ec7bf..4369a9021 100644
--- a/README.adoc
+++ b/README.adoc
@@ -33,7 +33,28 @@ Crash Course
 
 Report bugs or any other feedback
 ---------------------------------
-Please use the Issue tracker on github.
+Before reporting the bugs, please note that the bug needs to be validated w.r.t
+the latest version of elbe.
+Please use the Issue tracker on github. When reporting an issue, please give us
+the following information.
+
+* Reproducing steps. In the best case, having an xml file would be good.
+* In case the build failed, please give the exact error message. Or the log file.
+* If the error message is not helpful, please give the expected message with a
+  valid explanation.
+
+Contributions
+-------------
+
+* Please note that we follow the kernel coding style for this project as far as
+  possible.
+* If the contributions can be certified as given in https://developercertificate.org,
+  please add a "Signed-off by" tag with the commit.
+* Please note that we currently target python3.6+ before sending any source code.
+* Note that the moderator approval is needed when you send the patches. This
+  approval is available from a confirmation link that you receive once a patch or
+  an e-mail is sent to the the mailing list given below.
+
 
 Send patches to <elbe-devel at linutronix.de>.
 
-- 
2.30.2



More information about the elbe-devel mailing list