36
edits
Changes
Include addon version in the bug report
{{languages|How to report bugsUsing the bug tracker}}{{man tip|The bug/issue tracker for Gramps |is located at the following URL: <code>https://www.gramps-project.org/bugs</code>}}
This bug/issue tracker allows users and developers to log new issues and track them as they progress. Please take some time to read the issue tracker instructions below and read '''[[How to create a good bug report|how to create a good bug report]]'''. Also, have a look at '''[[Known_issues|known issues]]''' and '''[[Common_problems|common problems]]'''.
== Quick recommendations ==
When composing a problem (bug) report for Gramps:* Be '''''precise'''''* Be '''''clear''': '' explain how to reproduce the problem, step by step, so others can reproduce the bug, or understand the request.* Include only '''''one problem per report'''''* Include any relevant links and '''''examples'''''{{man tip|Before you create a "Bug" report...|Composing a bug report can involve a lot of research and writing effort. Save yourself from unnecessary work.<ul><li>A solution or workaround might already exist in another bug report or in the forums.</li><li>If you connot find anything resembling your issue, ask about it in one of the forums. The community will help you solve or isolate the problem.</li></ul> }}
==Report a bug==
===1. Login===
To report a bug or raise a feature request, you must have a login account on the '''Gramps bug tracker''' ''([https://www.mantisbt.org/ powered by MantisBT])'':* [https://bugs.gramps-project.org {{man button|Login}} ] to your account at https://gramps-project.org/bugs/login_page.php , or;* Select [https://gramps-project.org/bugs/signup_page.php {{man button|Signup for a new account}} ] or visit the following link to create a new login account: https://gramps-project.org/bugs/signup_page.php . When you create a user account Due to periodic SPAMbot activity, remember New Account requests might require human pre-approval. Be aware that this means that it can might take up to 12 hours before a notification confirmation email is send to yousent when creating a user account. Only after clicking on the link in the confirmation email can you submit bugs. Your email address will be handled confidentially.
{{-}}
===2. Search wiki and existing bugs===
[[File:Search box for existing bugs.png|thumb|right|450px|Search Box]]
If the bug is already reported, read over the bug report, and see if you can add to the information. If so, you can leave a note with extra information to help the developers.
*The '''Gramps''' project is a place for recording all issues with Gramps.
**If the issue represents a problem with functionality that has been released in a stable release of codeor a problem with functionality that only exists in the master branch, then the issue should be filed under the project that corresponds to the maintenance branch for that release. For example, a bug found in Gramps 5.1.0 should be filed under the '''Gramps 5.1.0''' project.
*If the issue represents a problem with functionality that only exists in the master branchFor bug reports and feature requests relating to Gramps Web, or the problem exists in the master branch, but not any stable releases, then the issue should be filed under the '''see [https://www.grampsweb.org/help/ | Get Help - Gramps Master''' project.Web]
{{-}}
The {{man label|Enter Issue Details}} page is where you share with the developers what your issue or feature request is.
Try and complete all the relevant sections as well as you can and be prepared to answer follow up questions if your report needs clarification, it may help you to read the . Here's a concise guide on '''[[How to create a good bug report]]''' articlefor Gramps which will greatly increase the chances of reproducibility and thus being fixed.
===== Filling out the page =====
* Select Profile
** Gramps runs on multiple operating systems, so it's important to know which operating system and version you are reporting an issue against. This is where you provide that information. MantisBT allows you store multiple profiles in your Account so that you can pick the appropriate one, which is handy if you run Gramps on different system configurations.
* Product Version
**The projects with names that look like '''Gramps x.x.X''' are where issues are reported that apply specifically to a maintenance branch (see [[Brief_introduction_to_Git#Types_of_branches|Types of Branches]]). A separate project exists for each maintenance branch.
**The For recording issues that '''Gramps Master'only'' project should only be used by developers and testers of the latest code. It is a place for recording issues that only apply to the master branch in Git (see [[Brief_introduction_to_Git#Types_of_branches|Types of Branches]]), use next un-released version e.g.: 5.3. There is only one "Gramps Master" 0 as shown on the [https://gramps-project because there is only one master branch .org/bugs/roadmap_page.php| MantisBT Roadmap].* Addon Version** If you are reporting a bug in an addon, use the Plugin Manager or Enhanced Plugin Manager to find the version of the addon and include it in the Git repositoryreport.
{{-}}
==Useful MantisBT bug tracker Syntax codes==
* A [https://github.com/mantisbt/mantisbt/blob/55fb5721ea7d980557da484390db5c6003b63cd0/config_defaults_inc.php#L1979 limited set] of [https://www.w3schools.com/tags/ HTML tags] can be used in the text field:
**<code> <p> </p></code> to define a paragraph.
**<code> <em> </em></code> It renders as emphasized text.
**<code> <strong></code> It defines important text.
==See also==
* [[Known issues]]
* [[Common problems]]
* Help the Gramps project [[Bug triage]] MantisBT.org reports providing user-oriented (''not'' admin) documentation* [https://www.mantisbt.org/bugs/view.php?id=5070 0005070]: I have written [MantisBT] quick-start documentation [.doc, .pdf, .swx] if you’re interested* [https://www.mantisbt.org/bugs/view.php?id=8939 0008939]: Lifecycle model [Visio] for a report in MantisBT
[[Category:Developers/General]]
[[Category:Developers/Quality Assurance]]