diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..5383b663 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. +Also how to reproduce, the expected behavior. + +**Phtoto/video (optional) that causes the bug** +If error is in connection with a particular photo/video, It would help a lot with the debugging if you can attach that file too. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Enviroment (please complete the following information):** + - OS: [e.g. server runs on linux, browser on windows] + - Browser [e.g. chrome, safari] + +**Used app version**: +- compiled from source +- docker-nightly +- docker-vXX +- release vXX +- ect... diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..2f826209 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** (optional) +A clear and concise description of any alternative solutions or features you've considered. diff --git a/README.md b/README.md index 9de7cf16..bee96fc0 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,9 @@ Live Demo @ heroku: https://pigallery2.herokuapp.com/ 1. [Getting started](#1-getting-started-on-raspberry-pi) 2. [Translate the page to your own language](#2-translate-the-page-to-your-own-language) 3. [Feature list](#3-feature-list) -4. [Known errors](#4-known-errors) -5. [Credits](#5-credits) +4. [Suggest/endorse new features](#4-suggestendorse-new-features) +5. [Known errors](#5-known-errors) +6. [Credits](#6-credits) @@ -185,14 +186,20 @@ apt-get install build-essential libkrb5-dev gcc g++ * **Markdown based blogging support** - `future plan` * you can write some note in the blog.md for every directory * bug free :) - `In progress` + + +## 4. Suggest/endorse new features + You are welcome to suggest new features to the application via [github issues](https://github.com/bpatrik/pigallery2/issues). + I cannot garantie any dealine with the development of a new feature. (I usually fix bugs within week/weeks.) + I will give a higher priority to a feature that has more 'likes' (i.e.: `+1`-s or thumbs ups) on it. -## 4. Known errors +## 5. Known errors * EXIF orientation tag: * There is no nice way to handle EXIF orientation tag properly. The page handles these photos, but might cause same error in the user experience (e.g.: the pages loads those photos slower. See issue [#11](https://github.com/bpatrik/pigallery2/issues/11)) * Video support on weak servers (like raspberry pi) with low upload rate * video playback may use up too much resources and the server might not response for a while. A solution might be to down scale / convert the video files to lower bitrate. -## 5. Credits +## 6. Credits Crossbrowser testing sponsored by [Browser Stack](https://www.browserstack.com) [Browser Stack](https://www.browserstack.com)