diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md deleted file mode 100644 index e027265fb1..0000000000 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug report -about: Create a report to help Firefly III improve -title: '' -labels: '' -assignees: '' - ---- - -**Bug description** -I am running Firefly III version x.x.x, and my problem is: - - - -**Steps to reproduce** - - -**Extra info** - - - -**Bonus points** - - -- I searched and nobody reported this bug before -- I have added a stack trace from my log files -- I have added a screenshot. -- I was able to replicate it on the demo site https://demo.firefly-iii.org/ - diff --git a/.github/ISSUE_TEMPLATE/Custom.md b/.github/ISSUE_TEMPLATE/Custom.md deleted file mode 100644 index c957ae752e..0000000000 --- a/.github/ISSUE_TEMPLATE/Custom.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: I have a question or a problem -about: Ask away! - ---- - -I am running Firefly III version x.x.x. - -**Description** - - -**Extra info** - - -**Bonus points** - - - -- I have read the FAQ at https://bit.ly/FF3-FAQ -- I added a screenshot -- I added log files -- I was able to replicate the issue on the demo site. - diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md deleted file mode 100644 index bf2b2aa03f..0000000000 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Feature request -about: Suggest an idea or feature for Firefly III -title: '' -labels: '' -assignees: '' - ---- - -**Description** - - -**Solution** - - -**What are alternatives?** - - -**Additional context** - - -**Bonus points** - diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000000..e4edeca6d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,64 @@ +name: Bug Report +description: Report a bug in Firefly III (or associated tools) +body: + - type: checkboxes + attributes: + label: Support guidelines + description: Please read the support guidelines before proceeding. + options: + - label: I've read the [support guidelines](https://github.com/firefly-iii/firefly-iii/blob/main/.github/support.md) + required: true + + - type: checkboxes + attributes: + label: I've found a bug and checked that ... + description: Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, explain in detail why. + options: + - label: ... the documentation does not mention anything about my problem + - label: ... there are no open or closed issues that are related to my problem + + - type: textarea + attributes: + label: Description + description: Please provide a brief description of the bug in 1-2 sentences. + validations: + required: true + + - type: textarea + attributes: + label: Expected behaviour + description: Please describe precisely what you'd expect to happen. + validations: + required: true + + - type: textarea + attributes: + label: Actual behaviour + description: Please describe precisely what is actually happening. + validations: + required: true + + - type: textarea + attributes: + label: Steps to reproduce + description: Please describe the steps to reproduce the bug. + placeholder: | + 1. ... + 2. ... + 3. ... + validations: + required: true + + - type: textarea + attributes: + label: Debug information + description: Please provide the table from the /debug page + placeholder: The output from the /debug page + render: yaml + validations: + required: true + + - type: textarea + attributes: + label: Additional info + description: Please provide any additional information that seem useful. diff --git a/.github/ISSUE_TEMPLATE/fr.yml b/.github/ISSUE_TEMPLATE/fr.yml new file mode 100644 index 0000000000..6fb1ec1819 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/fr.yml @@ -0,0 +1,40 @@ +name: Feature Request +description: Request a feature or enhancement in Firefly III (or associated tools) +body: + - type: checkboxes + attributes: + label: Support guidelines + description: Please read the support guidelines before proceeding. + options: + - label: I've read the [support guidelines](https://github.com/firefly-iii/firefly-iii/blob/main/.github/support.md) + required: true + - label: My request is not listed as [an idea that won't be implemented](https://docs.firefly-iii.org/firefly-iii/support/features/#ideas-that-wont-be-implemented) + required: true + + - type: textarea + attributes: + label: Description + description: Please describe your feature request + placeholder: | + - I would like Firefly III to do ABC. + - What if you would add feature XYZ? + - Firefly III doesn't do DEF. + validations: + required: true + + - type: textarea + attributes: + label: Solution + description: Describe what your feature would add to Firefly III. + validations: + required: true + + - type: textarea + attributes: + label: What are alternatives? + description: Please describe what alternatives currently exist. + + - type: textarea + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. diff --git a/.github/support.md b/.github/support.md index e6e166bb22..440ba06fda 100644 --- a/.github/support.md +++ b/.github/support.md @@ -1,12 +1,32 @@ -# Welcome to Firefly III on Github! +# Support [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/firefly-iii/firefly-iii.svg)](http://isitmaintained.com/project/firefly-iii/firefly-iii "Average time to resolve an issue") :+1::tada: Thank you for taking the time to contribute something to Firefly III! -## Bugs +## Reporting an issue -First of all: thank you for reporting a bug instead of ditching the tool altogether. If you find a bug, please take the time and see if the [demo site](https://demo.firefly-iii.org/) is also suffering from this bug. Include as many log files and details as you think are necessary. Bugs have a lot of priority! +First of all: thank you for reporting a bug instead of ditching the tool altogether. Bugs have a lot of priority! -## Installation problems +1. Open bugs will have open issues, so search for one first. +2. If your feature request is already there, vote on it with :+1: or :-1: reactions. +3. Do NOT hijack old issues with the bug you found, open your own issue. +4. If relevant, take the time and see if the [demo site](https://demo.firefly-iii.org/) is also suffering from your issue. +5. If relevant, read the [documentation](https://docs.firefly-iii.org/). -Please take the time to read the [documentation](https://docs.firefly-iii.org/) and make sure you search through closed issues for the problems other people - have had. Your problem may be among them! If not, open an issue and I will help where I can. \ No newline at end of file +Please follow these guidelines when opening new issues: + +## Writing good issues + +- File a single issue for a single problem or feature requests. Feel free to open multiple issues. +- Collect as many details as you can. +- Be clear and specific, and state what you're not sure about. + +Only then [create a new issue](https://github.com/firefly-iii/firefly-iii/issues/new/choose)! + +## Issue closure and abandonment policy + +- Issues can be converted into discussions if it's not a bug or feature request. +- Features that won't be implemented will be labelled "wontfix". [This isn't personal](https://docs.firefly-iii.org/firefly-iii/support/features/#ideas-that-wont-be-implemented). +- Issues can be closed if they're duplicates of other issues. +- Issues can be closed if the answer is in the FAQ. +- Issues will be closed automatically after 14 days. +- Issues will be locked automatically after 90 days.