mirror of
https://github.com/wallabag/wallabag.git
synced 2024-11-26 19:11:07 +00:00
Merge pull request #1712 from wallabag/v2-contributing
Fix #1711: Update CONTRIBUTING file
This commit is contained in:
commit
b60bff0c2a
2 changed files with 16 additions and 17 deletions
12
.github/CONTRIBUTING.md
vendored
12
.github/CONTRIBUTING.md
vendored
|
@ -4,27 +4,21 @@
|
||||||
Please [open a new issue](https://github.com/wallabag/wallabag/issues/new).
|
Please [open a new issue](https://github.com/wallabag/wallabag/issues/new).
|
||||||
|
|
||||||
To fix the bug quickly, we need some infos:
|
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 wallabag version (in `app/config/config.yml`, see `wallabag_core.version`)
|
||||||
* your webserver installation :
|
* your webserver installation :
|
||||||
* type of hosting (shared or dedicated)
|
* type of hosting (shared or dedicated)
|
||||||
* in case of a dedicated server, the server and OS used
|
* in case of a dedicated server, the server and OS used
|
||||||
* the php version used, eventually `phpinfo()`
|
* the php version used, eventually `phpinfo()`
|
||||||
* which storage system you choose at install (SQLite, MySQL/MariaDB or PostgreSQL)
|
* 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
|
* any particular details which could be related
|
||||||
|
|
||||||
|
|
||||||
If relevant :
|
If relevant :
|
||||||
* the link you want to save and which causes problem
|
* the link you want to save and which causes problem
|
||||||
* the file you want to import into wallabag, or just an extract
|
* the file you want to import into wallabag, or just an extract
|
||||||
|
|
||||||
If you have the skills :
|
If you have the skills, look for errors into php, server and application (see `var/logs`) logs
|
||||||
* 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.
|
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
|
## 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**.
|
Please fork wallabag and work with **the v2 branch** only. **Do not work on master branch**.
|
||||||
|
|
||||||
[Don't forget to read our guidelines](https://github.com/wallabag/wallabag/blob/dev/GUIDELINES.md).
|
|
||||||
|
|
21
.github/ISSUE_TEMPLATE.md
vendored
21
.github/ISSUE_TEMPLATE.md
vendored
|
@ -1,13 +1,18 @@
|
||||||
### Issue details
|
### Issue details
|
||||||
|
|
||||||
_Please provide issue details here_.
|
Please provide issue details here.
|
||||||
|
Remember, this is _not_ a place to ask questions. For that, go to http://gitter.im/wallabag/wallabag.
|
||||||
|
|
||||||
|
### Environment
|
||||||
|
|
||||||
|
* wallabag version (or git revision) that exhibits the issue:
|
||||||
|
* Last wallabag version that did not exhibit the issue (if applicable):
|
||||||
|
* php version:
|
||||||
|
* OS:
|
||||||
|
* type of hosting (shared or dedicated):
|
||||||
|
* which storage system you choose at install (SQLite, MySQL/MariaDB or PostgreSQL):
|
||||||
|
|
||||||
### Steps to reproduce/test case
|
### Steps to reproduce/test case
|
||||||
|
|
||||||
_Please provide necessary steps for reproduction of this issue, or better the
|
Please provide necessary steps for reproduction of this issue, or better the
|
||||||
reduced test case (without any external dependencies, if possible)_.
|
reduced test case (without any external dependencies, if possible).
|
||||||
|
|
||||||
### Affected version(s)
|
|
||||||
|
|
||||||
_Please fill in affected version(s)_
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue