aboutsummaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md23
1 files changed, 20 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 85c09e52..9ccb0b14 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,11 +1,28 @@
1# How contributing 1# How to contribute
2 2
3## You found a bug 3## You found a bug
4Please [open a new issue](https://github.com/wallabag/wallabag/issues/new). 4Please [open a new issue](https://github.com/wallabag/wallabag/issues/new).
5 5
6To fix the bug quickly, we need some infos: 6To fix the bug quickly, we need some infos:
7* your wallabag version (in ./index.php) 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
17If relevant :
8* the link you want to save and which causes problem 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
21If 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
25Note : If you have large portions of text, use [Github's Gist service](https://gist.github.com/) or other pastebin-like.
9 26
10## You want to fix a bug or to add a feature 27## You want to fix a bug or to add a feature
11Please fork wallabag and work with **the dev branch** only. **Do not work on master branch**. \ No newline at end of file 28Please fork wallabag and work with **the dev branch** only. **Do not work on master branch**.