diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0c3388c..f10e927 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,32 +1,65 @@ --- name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' +about: 'Create a report to help us improve ' +title: "[BUG]" +labels: bug +assignees: magicsunday --- -**Describe the bug** -A clear and concise description of what the bug is. +Thank you for helping to improve the module! In order to analyze and resolve the reported error as quickly as possible, a detailed error description is crucial. The more information you provide, the easier it is for us to find the cause. Please fill in the following: -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +# Description of the problem +_Describe what exactly happened and how the error manifests itself._ +**Example:** "After saving a setting, an error message appears: 'Undefined index'." -**Expected behavior** -A clear and concise description of what you expected to happen. +**Enter:** -**Screenshots** -If applicable, add screenshots to help explain your problem. -**Desktop (please complete the following information):** - - Browser [e.g. chrome, safari] - - Webtrees version [e.g. 2.0.12] - - Version of pedigree chart [e.g. 1.2.7] +# Expected behavior +_Explain what you expected._ +**Example:** "The settings should be saved and a success message should be displayed." -**Additional context** -Add any other context about the problem here. +**Enter:** + + +# Steps to reproduction +_List all the steps necessary to reproduce the error._ +**Example:** +1. Open the module. +2. Click "Settings". +3. Change XYZ and click "Save". + +**Enter:** + + +# Error messages or screenshots +_If an error message appears, copy the full text. Screenshots also help a lot._ + +**Enter:** + + +# Technical Details +_Please specify the technical conditions:_ +* Webtrees version: (e.g. 2.x.x) +* Module version: (if known) +* Browser and operating system: (e.g. Chrome 117 on Windows 11) + +**Enter:** + + +# Additional Information +_Were there any special circumstances involved? Did you notice anything unusual? Was the module working correctly before a change or update?_ + +**Enter:** + + +# Log files +_Check the webtrees logs or server logs for entries related to the error and attach them._ +**Example:** `[2024-12-21 15:30:45] ERROR: Undefined function xyz() in /modules/modulname/module.php on line 123.` + +**Enter:** + + +# Note +Only with a detailed error description can we quickly find the cause of the problem and resolve it. Thank you for your help! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..5d649f3 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,48 @@ --- name: Feature request about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' +title: "[FEATURE]" +labels: enhancement +assignees: magicsunday --- -**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 [...] +Thank you for helping to further develop the module! In order to understand and implement your request for a new function or adjustment as clearly as possible, a detailed description is important. Please fill in the following points: -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +# Description of the desired function +_Describe the desired function or customization as specifically as possible._ +**Example:** "I wish the module offered an additional filter option to sort people by year of birth." -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +**Enter:** -**Additional context** -Add any other context or screenshots about the feature request here. + +# Purpose of the function +_Explain why this feature is useful or what problem it would solve._ +**Example:** "The additional filter option would make it easier to find people from a specific time period, which is especially important for historical analyses." + +**Enter:** + + +# Concrete use cases +_Describe how the feature would be used in practice._ +**Example:** "On the Advanced Search page, a dropdown menu could be added where the year of birth can be entered. Once entered, only people born in the specified year will be displayed." + +**Enter:** + + +# Priority of the wish +_How important is this feature to you? Is it essential or more of a 'nice-to-have'?_ +**Example:** "It is a desirable improvement that is not urgent but would make the workflow much easier." + +**Enter:** + + +# Technical details (if relevant) +_Are there any technical requirements, dependencies or suggestions for implementation?_ +**Example:** "Perhaps the function could build on the existing database query for advanced search." + +**Enter:** + + +# **Note** +A **clear and well thought-out description** of your request helps to plan and implement the function precisely. Thank you for your support in the further development of the module!