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

# How to contribute

## 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

If you have the skills, look for errors into php, server and application (see `var/logs`) 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**.
Commit	Line	Data
	1	# How to contribute
	2
	3	## You found a bug
	4	Please [open a new issue](https://github.com/wallabag/wallabag/issues/new).
	5
	6	To fix the bug quickly, we need some infos:
	7	* your wallabag version (in `app/config/config.yml`, see `wallabag_core.version`)
	8	* your webserver installation :
	9	* type of hosting (shared or dedicated)
	10	* in case of a dedicated 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 particular details which could be related
	14
	15	If relevant :
	16	* the link you want to save and which causes problem
	17	* the file you want to import into wallabag, or just an extract
	18
	19	If you have the skills, look for errors into php, server and application (see `var/logs`) logs
	20
	21	Note : If you have large portions of text, use [Github's Gist service](https://gist.github.com/) or other pastebin-like.
	22
	23	## You want to fix a bug or to add a feature
	24	Please fork wallabag and work with the v2 branch only. Do not work on master branch.