CONTRIBUTING.md

   1 # How to contribute
   2
   3 ## You found a bug
   4 Please [open a new issue](https://github.com/wallabag/wallabag/issues/new).
   5
   6 To fix the bug quickly, we need some infos:
   7 * your wallabag version (on top of the ./index.php file, and also on config page)
   8 * your webserver installation :
   9   * type of hosting (shared or dedicaced)
  10   * in case of a dedicaced server, the server and OS used
  11   * the php version used, eventually `phpinfo()`
  12 * which storage system you choose at install (SQLite, MySQL/MariaDB or PostgreSQL)
  13 * any problem on the `wallabag_compatibility_test.php` page
  14 * any particular details which could be related
  15
  16
  17 If relevant :
  18 * the link you want to save and which causes problem
  19 * the file you want to import into wallabag, or just an extract
  20
  21 If you have the skills :
  22 * enable DEBUG mode and look the output at cache/log.txt
  23 * look for errors into php and server logs
  24
  25 Note : If you have large portions of text, use [Github's Gist service](https://gist.github.com/) or other pastebin-like.
  26
  27 ## You want to fix a bug or to add a feature
  28 Please fork wallabag and work with **the dev branch** only. **Do not work on master branch**.
  29
  30 [Don't forget to read our guidelines](https://github.com/wallabag/wallabag/blob/dev/GUIDELINES.md).