gian/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve readability of CONTRIBUTING.md

Browse Source 
Signed-off-by: William Desportes <williamdes@wdes.fr>
This commit is contained in:
William Desportes 2020-09-15 14:47:46 +02:00
parent a1122ac377
commit 8c02e6d975
No known key found for this signature in database
GPG Key ID: 90A0EF1B8251A889
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md
View File

@ -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 <email@example.com>`
direct support for this, it is the same as adding `Signed-off-by: Your name <email@example.com>`
as the last line of the commit message.
Example: `Signed-off-by: Jane Smith <jane.smith@example.org>`
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