From c665b863c7c15c1928d63b55b13e3abd5790082e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 18 Feb 2016 13:15:11 +0100 Subject: Fix #1691 create ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE --- .github/CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 13 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 10 ++++++++++ 3 files changed, 53 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md (limited to '.github') 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 @@ +# 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 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 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). 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 @@ +### Issue details + +_Please provide issue details here_. + +### Steps to reproduce/test case + +_Please provide necessary steps for reproduction of this issue, or better the +reduced test case (without any external dependencies, if possible)_. + +### Affected version(s) + +_Please fill in affected version(s)_ + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..535d02a9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,10 @@ +| Q | A +| ------------- | --- +| Bug fix? | yes|no +| New feature? | yes|no +| BC breaks? | yes|no +| Deprecations? | yes|no +| Tests pass? | yes|no +| Fixed tickets | comma-separated list of tickets fixed by the PR, if any +| License | MIT +| Doc PR | reference to the documentation PR, if any -- cgit v1.2.3