aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md12
1 files changed, 3 insertions, 9 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index ffb29f9e..0b92775a 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -4,27 +4,21 @@
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 (on top of the ./index.php file, and also on config page) 7* your wallabag version (in `app/config/config.yml`, see `wallabag_core.version`)
8* your webserver installation : 8* your webserver installation :
9 * type of hosting (shared or dedicated) 9 * type of hosting (shared or dedicated)
10 * in case of a dedicated server, the server and OS used 10 * in case of a dedicated server, the server and OS used
11 * the php version used, eventually `phpinfo()` 11 * the php version used, eventually `phpinfo()`
12* which storage system you choose at install (SQLite, MySQL/MariaDB or PostgreSQL) 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 13* any particular details which could be related
15 14
16
17If relevant : 15If relevant :
18* the link you want to save and which causes problem 16* the link you want to save and which causes problem
19* the file you want to import into wallabag, or just an extract 17* the file you want to import into wallabag, or just an extract
20 18
21If you have the skills : 19If you have the skills, look for errors into php, server and application (see `var/logs`) logs
22* enable DEBUG mode and look the output at cache/log.txt
23* look for errors into php and server logs
24 20
25Note : If you have large portions of text, use [Github's Gist service](https://gist.github.com/) or other pastebin-like. 21Note : If you have large portions of text, use [Github's Gist service](https://gist.github.com/) or other pastebin-like.
26 22
27## You want to fix a bug or to add a feature 23## You want to fix a bug or to add a feature
28Please fork wallabag and work with **the dev branch** only. **Do not work on master branch**. 24Please fork wallabag and work with **the v2 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).