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 take us time, that we could be used to fix other bugs or make improvements.
  10
  11 2. Specify the phpMyAdmin, server, PHP, MySQL and browser information that may be helpful to fix the problem, especially exact **version numbers**.
  12
  13 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.
  14
  15 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.
  16
  17 5. **Security problems** should not be reported here. See [our security page](https://www.phpmyadmin.net/security/).
  18
  19 Thanks for your help!
  20
  21 Please report [bugs on GitHub][1].
  22
  23 [1]: https://github.com/phpmyadmin/phpmyadmin/issues/new
  24
  25 ## Patches submission
  26
  27 Patches are welcome as [pull requests on GitHub][2].  Please include a
  28 Signed-off-by tag in the commit message (you can do this by passing [`--signoff`][4] parameter to Git).
  29
  30 When creating the commit on GitHub or using some other tool which does not have
  31 direct support for this, it is the same as adding `Signed-off-by: Your name <email@example.com>`
  32 as the last line of the commit message.
  33
  34 Example: `Signed-off-by: Jane Smith <jane.smith@example.org>`
  35
  36 Note that by submitting patches with the Signed-off-by tag, you are giving
  37 permission to license the patch as GPLv2-or-later. See [the DCO file][3] for details.
  38
  39
  40 [2]: https://github.com/phpmyadmin/phpmyadmin/pulls
  41 [3]: https://github.com/phpmyadmin/phpmyadmin/blob/master/DCO
  42 [4]: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff
  43
  44 ## Triage issues [![Open Source Helpers](https://www.codetriage.com/phpmyadmin/phpmyadmin/badges/users.svg)](https://www.codetriage.com/phpmyadmin/phpmyadmin)
  45
  46 You can triage issues, which may include reproducing bug reports or asking for vital information, such as version numbers or reproduction instructions. If you would like to start triaging issues, one easy way to get started is to [subscribe to phpMyAdmin on CodeTriage](https://www.codetriage.com/phpmyadmin/phpmyadmin).
  47
  48 ## More information
  49
  50 You can find more information on our website:
  51
  52 https://www.phpmyadmin.net/contribute/