Changes

Jump to: navigation, search

Using the bug tracker

944 bytes removed, 15:04, 8 October 2022
Add syntax code for Gramps Pull-Request
{{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.
{{-}}
* 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 ===
**<code> &lt;em&gt; &lt;/em&gt;</code> It renders as emphasized text.
**<code> &lt;strong&gt;</code> It defines important text.
 
== Resolving bugs for developers ==
This information is for the developers following up on the submitted issues.
 
The [https://gramps-project.org/bugs/roadmap_page.php roadmap page] of the bug tracker lists the bugs currently prioritized for the next releases. If you are looking for a bug to fix, this is a good place to start. Placement on the roadmap is controlled by the "Target Version" field fo the bug. Special "X.Y.99" phony releases, such as "3.4.99" and "4.0.99", list bugs that we would eventually like to fix for the "X.Y" version, but don't really know the milestone yet. Bugs that really should hold up a release
should be on the roadmap with a real release number, and should only be moved after giving a reason or heads up on the devel list [http://sourceforge.net/mailarchive/message.php?msg_id=31870820]. If you fix a bug scheduled for a later
milestone before a previous one is out, '''please manually adjust the target release field before marking the bug resolved,''' otherwise the roadmap display will be inaccurate [http://sourceforge.net/mailarchive/message.php?msg_id=31870821].
 
In general, when resolving an issue, it is always a good idea to add a note with the hash of the commit that fixed the problem.
 
When resolving issues in a maintenance branch, one should always set the "Fixed in version" field to the version of the next release that will be made from that branch. This is done so that the issue properly appears in the ChangeLog page for that project ( https://gramps-project.org/bugs/changelog_page.php ).
 
Bugs in maintenance branch projects should not be marked as closed until the developer has committed the change into the corresponding maintenance branch. Additionally, it is the developers responsibility to make sure the change has been merged into the master branch.
==See also==
36
edits

Navigation menu