From 1714308e1a10805776bbff1793ee7cd5a30385f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Viguier?= Date: Thu, 8 Feb 2024 19:33:30 +0100 Subject: [PATCH] Update readme and few more (#2283) * update readme :( * add sponsor button * disable issues and point to discussions instead (for improved triaging). --- .github/DISCUSSION_TEMPLATE/bugs.yml | 64 +++++++++++++++++++++++++++ .github/DISCUSSION_TEMPLATE/ideas.yml | 14 ++++++ .github/FUNDING.yml | 13 ++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++++ README.md | 24 ++++++++++ 5 files changed, 126 insertions(+) create mode 100644 .github/DISCUSSION_TEMPLATE/bugs.yml create mode 100644 .github/DISCUSSION_TEMPLATE/ideas.yml create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/DISCUSSION_TEMPLATE/bugs.yml b/.github/DISCUSSION_TEMPLATE/bugs.yml new file mode 100644 index 00000000000..82762a5427f --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/bugs.yml @@ -0,0 +1,64 @@ +body: + - type: markdown + attributes: + value: | + Create a bug report to help us improve, do not ignore the [REQUIRED] sections. + We understand this can be frustrating, take your time and relax. We are usually + pretty quick to answer. :) + Valid bug report will be converted into proper issues to track their advancement. + - type: input + id: lychee-version + attributes: + label: Lychee version + description: Which version of Lychee are you using? Please provide the full version, e.g. v3.2.6. + placeholder: v5.1.2 + validations: + required: true + + - type: dropdown + id: php-version + attributes: + label: Which PHP version are you using? + options: + - PHP 8.3 + - PHP 8.2 + validations: + required: true + + - type: textarea + attributes: + label: Detailed description of the problem + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + attributes: + label: Steps to reproduce the issue + description: | + Which steps do we need to take to reproduce the problem you are having? + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + + - type: textarea + attributes: + label: Diagnostics [REQUIRED] + description: | + Paste here is the content of your diagnostics. + *(Settings => Diagnostics or https://example.com/Diagnostics or `php artisan lychee:diagnostics`)* + placeholder: | + ``` + Paste result here + ``` + + - type: checkboxes + attributes: + label: Please confirm (incomplete submissions will not be addressed) + options: + - label: I have provided easy and step-by-step instructions to reproduce the bug. + required: true + - label: I understand my bug report will be removed if I haven't met the criteria above. + required: true \ No newline at end of file diff --git a/.github/DISCUSSION_TEMPLATE/ideas.yml b/.github/DISCUSSION_TEMPLATE/ideas.yml new file mode 100644 index 00000000000..9c47bf9b846 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/ideas.yml @@ -0,0 +1,14 @@ +body: + - type: markdown + attributes: + value: | + Suggest an idea for this project. :) + + Valid ideas will be converted into proper issues to track their advancement. + + - type: textarea + attributes: + label: Enhancement + description: Explain in a few words which functionality or improvements you would like to see in Lychee. + validations: + required: true \ No newline at end of file diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000000..0a843289459 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,13 @@ +# These are supported funding model platforms + +github: LycheeOrg # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +# patreon: # Replace with a single Patreon username +open_collective: LycheeOrg +# ko_fi: # Replace with a single Ko-fi username +# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +# liberapay: # Replace with a single Liberapay username +# issuehunt: # Replace with a single IssueHunt username +# otechie: # Replace with a single Otechie username +# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry +# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..cdbf0a20ad9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: I think I found a bug! + url: https://github.com/LycheeOrg/Lychee/discussions/new?category=bugs + about: Please submit your a bug here. + - name: I have an idea/suggestion. + url: https://github.com/LycheeOrg/Lychee/discussions/new?category=ideas + about: Please submit your ideas here. + - name: I have a question. + url: https://github.com/LycheeOrg/Lychee/discussions/new?category=q-a + about: Please ask and answer questions here. diff --git a/README.md b/README.md index 4fd7016087f..42245790f27 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,30 @@ Upgrade from v3 is straight forward. [Upgrade. »](https://lycheeorg.github. Lychee is a free photo-management tool, which runs on your server or web-space. Installing is a matter of seconds. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely. Read more on our [website](https://LycheeOrg.github.io). +## Notice: `master` & `alpha` branches + +As LycheeOrg is a very small team, we do not have many maintainers. Most of us have an active work/family life, and as a result, it is no longer possible for us to apply proper 4-eyes principle in the coding reviews. + +In order to keep our high code quality, the following changes have been applied. + +- `master` stays as a stable branch and contains 4-eyes peer-reviewed pull-requests. +- `alpha` contains the latest changes (i.e. the above mentionned PR) merged with minimal review. + +With this change, we hope to strike a balance between decently paced development (on `alpha`) and maintaining a robust core (on `master`). + +On Docker, `nightly`/`dev` continues to refer to the latest `master` commit. +The `alpha` tag is updated daily with the content of the associated branch. + +That being said, if you like the gallery and would like to contribute, do not hesitate to open pull request. If you would like to see more functionalities added and help us push Lychee, [Join the team!](https://lycheeorg.github.io/docs/contributions.html#joining-the-team) + +### Support the Team + +We aim to maintain a free open-source photography library with high quality of code.
+Being in control of our own data, our own pictures is something that we value above all. + +Through [contributions, donations, and sponsorship](https://github.com/sponsors/LycheeOrg), you allow Lychee to thrive. Your donations directly support demo server costs, continuous enhancements, and most importantly bug fixes! + + ## Installation To run Lychee, everything you need is a web-server with PHP 8.2 or later and a database (MySQL/MariaDB, PostgreSQL or SQLite). Follow the instructions to install Lychee on your server. This version of Lychee is built on the Laravel framework. To install: