CONTRIBUTING.md

   1 # Contributing to phpMyAdmin
   2
   3 As an open source project, phpMyAdmin welcomes contributions of many forms.
   4
   5 ## Bug reporting
   6
   7 We appreciate your effort to improve phpMyAdmin by submitting a bug report. Before doing so, please check the following things:
   8
   9 1. Check whether the bug you face **hasn't been already reported**. Duplicate reports takes us time, that we could be used to fix other bugs or make improvements.
  10 2. Specify the phpMyAdmin, server, PHP, MySQL and browser information that may be helpful to fix the problem, especially exact **version numbers**.
  11 3. If you got some error, please **describe what happened** and add error message. Reports like "I get error when I clicked on some link." are useless.
  12 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.
  13 5. **Security problems** should not be reported here. See [our security page](https://www.phpmyadmin.net/security/).
  14 Thanks for your help!
  15
  16 Please report [bugs on GitHub][1].
  17
  18 [1]: https://github.com/phpmyadmin/phpmyadmin/issues/new
  19
  20 ## Patches submission
  21
  22 Patches are welcome as [pull requests on GitHub][2].  Please include a
  23 Signed-off-by tag in the commit message (you can do this by passing [`--signoff`][4]
  24 parameter to Git).
  25
  26 When creating the commit on GitHub or using some other tool which does not have
  27 direct support for this, it is the same as adding
  28 `Signed-off-by: Your name <email@example.com>`
  29 as the last line of the commit message.
  30
  31 Example: `Signed-off-by: Jane Smith <jane.smith@example.org>`
  32
  33 Note that by submitting patches with the Signed-off-by tag, you are giving
  34 permission to license the patch as GPLv2-or-later.  See [the DCO file][3] for
  35 details.
  36
  37
  38 [2]: https://github.com/phpmyadmin/phpmyadmin/pulls
  39 [3]: https://github.com/phpmyadmin/phpmyadmin/blob/master/DCO
  40 [4]: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff
  41
  42 ## More information
  43
  44 You can find more information on our website:
  45
  46 https://www.phpmyadmin.net/contribute/