X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=CONTRIBUTING.md;h=ffb29f9eb249282c351dfd461f2a5b8edc5a5adf;hb=ea3b573653aeb2c48fcaa52b4dd80e70cae4ea7b;hp=7fdca652bb538355d62869c83d07bdaa6ad8166d;hpb=c95b78a8ceb918f033f3dd6c26aa7da4a8a527dc;p=github%2Fwallabag%2Fwallabag.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7fdca652..ffb29f9e 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/wallabag/demo.wallabag.org/issues/new). +Please [open a new issue](https://github.com/wallabag/wallabag/issues/new). To fix the bug quickly, we need some infos: -* your demo.wallabag.org version (in ./index.php) +* 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**. \ 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).