Merge pull request #4438 from wallabag/dependabot/composer/scheb/two-factor-bundle...

[github/wallabag/wallabag.git] / .github / CONTRIBUTING.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 0b92775aaa220aef5aa64697c4d340c9ff9e15cb..d5599206751a2ff5fd7626f8cc78c7907c547a69 100644 (file)
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,24 +1,43 @@
 # How to contribute
 
+## Test it locally
+
+### Using Docker
+
+- Clone the repository
+- Ensure your Docker daemon is running
+- Launch `docker-compose up`
+
+You'll then have:
+- a web server (nginx)
+- a PHP daemon (using FPM)
+- a Redis database (to handle imports)
+- a SQLite database to store articles
+
+You can now access your wallabag instance using that url: `http://127.0.0.1:8000`
+
+If 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.
+
+### Using your own PHP server
+
+- Ensure you are running PHP > 7.1.
+- Clone the repository
+- Launch `composer install`
+- If you got some errors, fix them (they might be related to some missing PHP extension from your machine)
+- Then `php bin/console wallabag:install`
+- If you got some errors, fix them (they might be related to some missing PHP extension from your machine)
+- Run `php bin/console server:run`
+
+You can now access your wallabag instance using that url: `http://127.0.0.1:8000`
+
 ## You found a bug
 Please [open a new issue](https://github.com/wallabag/wallabag/issues/new).
 
-To fix the bug quickly, we need some infos:
-* your wallabag version (in `app/config/config.yml`, see `wallabag_core.version`)
-* 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 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
+To fix the bug quickly, we need some infos: please answer to the questions in the issue form.
 
-If you have the skills, look for errors into php, server and application (see `var/logs`) logs
+If you have the skills, look for errors into PHP, server and application logs (see `var/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 v2 branch** only. **Do not work on master branch**.
+Please fork wallabag and work with **the master branch**.