X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=CONTRIBUTING.md;h=ffb29f9eb249282c351dfd461f2a5b8edc5a5adf;hb=f967422fae64311339a248e5b4891c55f6c989d7;hp=9818ae008240454da480f9905930d453ab826d6d;hpb=0269cd821311500acffed61edb1bc168d3fb5ec8;p=github%2Fwallabag%2Fwallabag.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md old mode 100755 new mode 100644 index 9818ae00..ffb29f9e --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,30 @@ -# How contributing +# How to contribute -When you create an issue on github, don't forget to give us your poche version. You can find it in config screen or in ./inc/poche/config.inc.php. \ No newline at end of file +## You found a bug +Please [open a new issue](https://github.com/wallabag/wallabag/issues/new). + +To fix the bug quickly, we need some infos: +* your wallabag version (on top of the ./index.php file, and also on config page) +* your webserver installation : + * type of hosting (shared or dedicated) + * in case of a dedicated server, the server and OS used + * the php version used, eventually `phpinfo()` +* which storage system you choose at install (SQLite, MySQL/MariaDB or PostgreSQL) +* any problem on the `wallabag_compatibility_test.php` page +* any particular details which could be related + + +If relevant : +* the link you want to save and which causes problem +* the file you want to import into wallabag, or just an extract + +If you have the skills : +* enable DEBUG mode and look the output at cache/log.txt +* look for errors into php and server logs + +Note : If you have large portions of text, use [Github's Gist service](https://gist.github.com/) or other pastebin-like. + +## You want to fix a bug or to add a feature +Please fork wallabag and work with **the dev branch** only. **Do not work on master branch**. + +[Don't forget to read our guidelines](https://github.com/wallabag/wallabag/blob/dev/GUIDELINES.md).