aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md32
1 files changed, 31 insertions, 1 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 920f1905..d5599206 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,11 +1,41 @@
1# How to contribute 1# How to contribute
2 2
3## Test it locally
4
5### Using Docker
6
7- Clone the repository
8- Ensure your Docker daemon is running
9- Launch `docker-compose up`
10
11You'll then have:
12- a web server (nginx)
13- a PHP daemon (using FPM)
14- a Redis database (to handle imports)
15- a SQLite database to store articles
16
17You can now access your wallabag instance using that url: `http://127.0.0.1:8000`
18
19If you want to test using an other database than SQLite, uncomment the `postgres` or `mariadb` code from the `docker-compose.yml` file at the root of the repo. Also uncomment related line in the `php` section so the database will be linked to your PHP instance.
20
21### Using your own PHP server
22
23- Ensure you are running PHP > 7.1.
24- Clone the repository
25- Launch `composer install`
26- If you got some errors, fix them (they might be related to some missing PHP extension from your machine)
27- Then `php bin/console wallabag:install`
28- If you got some errors, fix them (they might be related to some missing PHP extension from your machine)
29- Run `php bin/console server:run`
30
31You can now access your wallabag instance using that url: `http://127.0.0.1:8000`
32
3## You found a bug 33## You found a bug
4Please [open a new issue](https://github.com/wallabag/wallabag/issues/new). 34Please [open a new issue](https://github.com/wallabag/wallabag/issues/new).
5 35
6To fix the bug quickly, we need some infos: please answer to the questions in the issue form. 36To fix the bug quickly, we need some infos: please answer to the questions in the issue form.
7 37
8If you have the skills, look for errors into php, server and application (see `var/logs`) logs. 38If you have the skills, look for errors into PHP, server and application logs (see `var/logs`).
9 39
10Note : If you have large portions of text, use [Github's Gist service](https://gist.github.com/) or other pastebin-like. 40Note : If you have large portions of text, use [Github's Gist service](https://gist.github.com/) or other pastebin-like.
11 41