X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=CONTRIBUTING.md;h=58bc7134545a15b10f765e033320b83216c35c7d;hb=dc61832a9e741e346d7d9272fe8224699b3f32aa;hp=85132e65555918625a91ef160d94822430bd68dd;hpb=c51be6b697da573cdcf0788eb8617130ce5517a4;p=github%2Fwallabag%2Fwallabag.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85132e65..58bc7134 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,30 @@ -# How contributing +# How to contribute ## You found a bug -Please [open a new issue](https://github.com/inthepoche/poche/issues/new). +Please [open a new issue](https://github.com/wallabag/wallabag/issues/new). To fix the bug quickly, we need some infos: -* your poche version (in ./inc/poche/myconfig.inc.php) -* the link you want to poche and which causes problem +* your wallabag version (on top of the ./index.php file, and also on config page) +* your webserver installation : + * type of hosting (shared or dedicaced) + * in case of a dedicaced 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 poche and work with the dev branch. Do not work on master branch. \ No newline at end of file +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). \ No newline at end of file