aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github
diff options
context:
space:
mode:
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md30
-rw-r--r--.github/ISSUE_TEMPLATE.md13
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md11
3 files changed, 54 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 00000000..ffb29f9e
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,30 @@
1# How to contribute
2
3## You found a bug
4Please [open a new issue](https://github.com/wallabag/wallabag/issues/new).
5
6To fix the bug quickly, we need some infos:
7* your wallabag version (on top of the ./index.php file, and also on config page)
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 problem on the `wallabag_compatibility_test.php` page
14* any particular details which could be related
15
16
17If relevant :
18* the link you want to save and which causes problem
19* the file you want to import into wallabag, or just an extract
20
21If 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
25Note : If you have large portions of text, use [Github's Gist service](https://gist.github.com/) or other pastebin-like.
26
27## You want to fix a bug or to add a feature
28Please fork wallabag and work with **the dev branch** only. **Do not work on master branch**.
29
30[Don't forget to read our guidelines](https://github.com/wallabag/wallabag/blob/dev/GUIDELINES.md).
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..bfd3d4d0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,13 @@
1### Issue details
2
3_Please provide issue details here_.
4
5### Steps to reproduce/test case
6
7_Please provide necessary steps for reproduction of this issue, or better the
8reduced test case (without any external dependencies, if possible)_.
9
10### Affected version(s)
11
12_Please fill in affected version(s)_
13
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..b761f8f2
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,11 @@
1| Q | A
2| ------------- | ---
3| Bug fix? | yes|no
4| New feature? | yes|no
5| BC breaks? | yes|no
6| Deprecations? | yes|no
7| Tests pass? | yes|no
8| Documentation | yes|no
9| Translation | yes|no
10| Fixed tickets | comma-separated list of tickets fixed by the PR, if any
11| License | MIT