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

[Bastian Germann]

Am 15.07.22 um 16:22 schrieb Viraj Shah:
> * 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 | 19 ++++++++++++++++++-
>   1 file changed, 18 insertions(+), 1 deletion(-)
> 
> diff --git a/README.adoc b/README.adoc
> index 4cd7ec7bf..133531559 100644
> --- a/README.adoc
> +++ b/README.adoc
> @@ -33,7 +33,24 @@ Crash Course
>   
>   Report bugs or any other feedback
>   ---------------------------------
> -Please use the Issue tracker on github.
> +Please use the Issue tracker on github. When reporting an issue, please give us
> +the following information.
> +
> +* The version of elbe used.

Please also note that the bug has to be validated with the latest version before posting.

> +* Reproducing steps. In best case, having an xml file would be good.

In the best case ...

> +* 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. So, please add the SOB tag with your patches.

SOB is not really part of the coding style. Please link to https://developercertificate.org.

> +* 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.
> +

Please fix the indentation.

>   Send patches to <elbe-devel at linutronix.de>.
>   

Please also note that we currently target Python 3.6+