View source for Using the bug tracker

{{languages|Using 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 .

Due to periodic SPAMbot activity, New Account requests might require human pre-approval. Be aware that this means that it might take up to 12 hours before a confirmation email is sent 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]]
Sometimes the behavior being observed might seem odd, yet as-designed. So the first step is to search the wiki to see what the documented behavior is. If you're still not sure, ask the [https://forum.gramps-project.org/ Gramps community on Discourse.]

If it still appears to be a bug, perhaps the bug you want to report has been reported before. To check this, click on [https://gramps-project.org/bugs/view_all_bug_page.php {{man button|View Issues}}]. The top of the page is reserved for filters, which you set. Normally the default filters are just fine. Under these filters, there is a {{man label|Search}} box. Enter the terms best describing the bug, and click {{man button|Apply Filter}} to search. If you have an error message, try pasting a part of the error, to see if it is has been reported already.

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.
{{-}}

===3. Submit new bug===
[[File:Report issue buttons Gramps bugs.png|thumb|right|450px|'Report Issue' buttons.]]
Click on one of the {{man label|Report Issue}} buttons, and enter the required information, see below on how to select the project to which the bug belongs. Be verbose, the developers are bad at mind reading. We shall mercilessly close the bugs which have no meaningful information at all, such as #{{bug|7126}}. Do not forget to list the Gramps version you are using. You can check this in Gramps by clicking in the Gramps program the Help menu, option About.
{{-}}
==== How to proceed ====
[[File:Dropdown-Choose-Project-GrampsBugtracker.png|thumb|right|450px|Choose Project - selection list]]
The first step in submitting an issue on the tracker is to determine which project it belongs to on the issue tracker from the '''Select Project''' box, use the '''Choose Project''' drop down list to select the "project" for the bugs. "Projects" are a way to categorize issues. There are two types of projects in the issue tracker, '''Feature Requests''' and '''Gramps''':

*The '''Feature Requests''' project is a place for recording requests for new features. 
**If the issue represents functionality that does not currently exist in Gramps, then the issue should be filed under the '''Feature Requests''' project.

*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 or a problem with functionality that only exists in the master branch, then the issue should be filed under the Gramps project.

* For bug reports and feature requests relating to Gramps Web, see [https://www.grampsweb.org/help/ | Get Help - Gramps Web]
{{-}}

==== Enter Issue Details ====
[[File:Enter Issue Details page Gramps bugs.png|thumb|right|550px|Enter Issue Details - page]]
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. Here's a concise guide on '''[[How to create a good bug report]]''' for 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.
**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.0 as shown on the [https://gramps-project.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 report.
{{-}}

==Useful MantisBT bug tracker Syntax codes==

The following are useful [http://www.mantisbt.org/ MantisBT bug tracker] syntax codes you can use:
* Using ''<code>#</code>'' before a bug number writes a link to the bug. eg: ''<code>#1</code>'' becomes {{bug|1}}
* Use ''<code>@</code>'' before a user name to mention a person (note: user names with embedded spaces are not supported)
* Using ''<code>~</code>'' before a comment number writes a link to the comment, same as : ''<code>{url}#c{comment number}</code>''. eg: ''<code>~3</code>'' becomes [https://gramps-project.org/bugs/view.php?id=1#c3]
* To link a GitHub Pull Request in the bug tracker, use p:gramps:nnnn: where nnnn is the PR number.

=== Limited HTML tags ===
* 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> &lt;p&gt; &lt;/p&gt;</code>  to define a paragraph.
**<code> &lt;li&gt;</code> to defines a [https://www.w3schools.com/tags/tag_li.asp list item] used with:
***<code> &lt;ul&gt;</code> unordered lists
***<code> &lt;ol&gt;</code> ordered lists
**<code> &lt;br&gt;</code> to insert a single line break.
**<code> &lt;pre&gt; &lt;/pre&gt;</code> to add preformatted text, that is displayed in a fixed-width font, and it preserves both spaces and line breaks.
**<code> &lt;i&gt;  &lt;/i&gt;</code> usually displays text in ''italics''.
**<code> &lt;b&gt; &lt;/b&gt;</code> shows '''bold''' text
**<code> &lt;u&gt; &lt;/u&gt;</code> Underline a misspelled word
**<code> &lt;em&gt; &lt;/em&gt;</code> It renders as emphasized text.
**<code> &lt;strong&gt;</code>  It defines important text.

==See also==
* [[How to create a good bug report]]
* [[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]]