[github/wallabag/wallabag.git] / 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 (on top of the ./index.php file, and also on config page)
* your webserver installation :
  * type of hosting (shared or dedicated)
  * in case of a dedicaced 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 problem on the `wallabag_compatibility_test.php` page
* 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 :
* enable DEBUG mode and look the output at cache/log.txt
* look for errors into php and server 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 dev branch** only. **Do not work on master branch**.

[Don't forget to read our guidelines](https://github.com/wallabag/wallabag/blob/dev/GUIDELINES.md).
Commit	Line	Data
230fa05e	1	# How to contribute
20ced8a8	2
b6680244	3	## You found a bug
26170f46	4	Please [open a new issue](https://github.com/wallabag/wallabag/issues/new).
b6680244 NL	5
b6680244 NL	6	To fix the bug quickly, we need some infos:
f034640c	7	* your wallabag version (on top of the ./index.php file, and also on config page)
f034640c	8	* your webserver installation :
2a2903ce	9	* type of hosting (shared or dedicated)
f034640c	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
	17	If relevant :
c95b78a8	18	* the link you want to save and which causes problem
f034640c	19	* the file you want to import into wallabag, or just an extract
	20
	21	If 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
	25	Note : If you have large portions of text, use [Github's Gist service](https://gist.github.com/) or other pastebin-like.
b6680244 NL	26
b6680244 NL	27	## You want to fix a bug or to add a feature
f034640c	28	Please fork wallabag and work with the dev branch only. Do not work on master branch.
70549136	29
2a2903ce	30	[Don't forget to read our guidelines](https://github.com/wallabag/wallabag/blob/dev/GUIDELINES.md).