From 8c02e6d975220049f59cd92defa18efe71d34c73 Mon Sep 17 00:00:00 2001 From: William Desportes Date: Tue, 15 Sep 2020 14:47:46 +0200 Subject: [PATCH] Improve readability of CONTRIBUTING.md Signed-off-by: William Desportes --- CONTRIBUTING.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 34115aec1f..6c3c5a7e1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,14 +4,19 @@ As an open-source project, phpMyAdmin welcomes contributions of many forms. ## Bug reporting -We appreciate your effort to improve phpMyAdmin by submitting a bug report. Before doing so, please check the following things: +We appreciate your effort to improve phpMyAdmin by submitting a bug report. Before doing so, please check the following things: + +1. Check whether the bug you face **hasn't been already reported**. Duplicate reports take us time, that we could be used to fix other bugs or make improvements. + +2. Specify the phpMyAdmin, server, PHP, MySQL and browser information that may be helpful to fix the problem, especially exact **version numbers**. + +3. If you got some error, please **describe what happened** and add an error message. Reports like "I get an error when I clicked on some link" are useless. + +4. Provide easy steps to reproduce and if possible include your table structure (``SHOW CREATE TABLE `tbl_name`;``); if your problem implies specific data, attach a small export file for sample rows. -1. Check whether the bug you face **hasn't been already reported**. Duplicate reports take us time, that we could be used to fix other bugs or make improvements. -2. Specify the phpMyAdmin, server, PHP, MySQL and browser information that may be helpful to fix the problem, especially exact **version numbers**. -3. If you got some error, please **describe what happened** and add an error message. Reports like "I get an error when I clicked on some link." are useless. -4. Provide easy steps to reproduce and if possible include your table structure (``SHOW CREATE TABLE `tbl_name`;``); if your problem implies specific data, attach a small export file for sample rows. 5. **Security problems** should not be reported here. See [our security page](https://www.phpmyadmin.net/security/). -Thanks for your help! + +Thanks for your help! Please report [bugs on GitHub][1]. @@ -20,19 +25,16 @@ Please report [bugs on GitHub][1]. ## Patches submission Patches are welcome as [pull requests on GitHub][2]. Please include a -Signed-off-by tag in the commit message (you can do this by passing [`--signoff`][4] -parameter to Git). +Signed-off-by tag in the commit message (you can do this by passing [`--signoff`][4] parameter to Git). When creating the commit on GitHub or using some other tool which does not have -direct support for this, it is the same as adding -`Signed-off-by: Your name ` +direct support for this, it is the same as adding `Signed-off-by: Your name ` as the last line of the commit message. Example: `Signed-off-by: Jane Smith ` Note that by submitting patches with the Signed-off-by tag, you are giving -permission to license the patch as GPLv2-or-later. See [the DCO file][3] for -details. +permission to license the patch as GPLv2-or-later. See [the DCO file][3] for details. [2]: https://github.com/phpmyadmin/phpmyadmin/pulls