188 lines
20 KiB
HTML
188 lines
20 KiB
HTML
<html><head><title>Bugtracker</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>Bugtracker</h1><span class="mw-redirectedfrom">(Redirected from <a href="https://www.freecadweb.org/wiki/index.php?title=Bugtracker&redirect=no" class="mw-redirect" title="Bugtracker">Bugtracker</a>)</span></div>
|
||
|
||
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr"><div class="mw-parser-output"><div class="floatright"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Mantis_logo_262x90.png" class="image" title="link=https://freecadweb.org/tracker/MantisBT is the bugtracker framework FreeCAD uses"><img alt="link=https://freecadweb.org/tracker/MantisBT is the bugtracker framework FreeCAD uses" src="Mantis_logo_262x90.png" width="262" height="90" /></a></div>
|
||
<p>The address of our bug tracker is:
|
||
</p><p><a rel="nofollow" class="external free" href="https://www.freecadweb.org/tracker">https://www.freecadweb.org/tracker</a>
|
||
</p><p>The Tracker is the place toː report bugs, submit feature requests, patches, or request to merge your branch if you developed something using Git. The tracker is divided into 'Workbenches', so please be specific and file your request in the appropriate subsection. In case of doubt, leave it in the "FreeCAD" section.
|
||
</p><p><br />
|
||
</p>
|
||
<div id="toc" class="toc"><div class="toctitle"><h2>Contents</h2></div>
|
||
<ul>
|
||
<li class="toclevel-1 tocsection-1"><a href="#Recommended_Workflow"><span class="tocnumber">1</span> <span class="toctext">Recommended Workflow</span></a></li>
|
||
<li class="toclevel-1 tocsection-2"><a href="#Reporting_bugs"><span class="tocnumber">2</span> <span class="toctext">Reporting bugs</span></a></li>
|
||
<li class="toclevel-1 tocsection-3"><a href="#Requesting_features"><span class="tocnumber">3</span> <span class="toctext">Requesting features</span></a></li>
|
||
<li class="toclevel-1 tocsection-4"><a href="#Submitting_patches"><span class="tocnumber">4</span> <span class="toctext">Submitting patches</span></a></li>
|
||
<li class="toclevel-1 tocsection-5"><a href="#Requesting_merge"><span class="tocnumber">5</span> <span class="toctext">Requesting merge</span></a></li>
|
||
<li class="toclevel-1 tocsection-6"><a href="#MantisBT_Tips_and_Tricks"><span class="tocnumber">6</span> <span class="toctext">MantisBT Tips and Tricks</span></a>
|
||
<ul>
|
||
<li class="toclevel-2 tocsection-7"><a href="#MantisBT_Markup"><span class="tocnumber">6.1</span> <span class="toctext">MantisBT Markup</span></a></li>
|
||
<li class="toclevel-2 tocsection-8"><a href="#MantisBT_BBCode"><span class="tocnumber">6.2</span> <span class="toctext">MantisBT BBCode</span></a></li>
|
||
<li class="toclevel-2 tocsection-9"><a href="#MantisBT_.3C.3D.3E_GitHub_Markup"><span class="tocnumber">6.3</span> <span class="toctext">MantisBT <=> GitHub Markup</span></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toclevel-1 tocsection-10"><a href="#GitHub_and_MantisBT"><span class="tocnumber">7</span> <span class="toctext">GitHub and MantisBT</span></a>
|
||
<ul>
|
||
<li class="toclevel-2 tocsection-11"><a href="#Attaching_a_git_commit_to_a_ticket"><span class="tocnumber">7.1</span> <span class="toctext">Attaching a git commit to a ticket</span></a></li>
|
||
<li class="toclevel-2 tocsection-12"><a href="#Remotely_resolving_a_ticket"><span class="tocnumber">7.2</span> <span class="toctext">Remotely resolving a ticket</span></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toclevel-1 tocsection-13"><a href="#Related"><span class="tocnumber">8</span> <span class="toctext">Related</span></a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<h2><span class="mw-headline" id="Recommended_Workflow">Recommended Workflow</span></h2>
|
||
<div class="center"><div class="floatnone"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Bugreport-workflow.png" class="image"><img alt="Bugreport-workflow.png" src="Bugreport-workflow.png" width="871" height="83" /></a></div></div>
|
||
<p>As shown in the above flowchart, before creating tickets, please always first search the forums and bugtracker to discover if your issue is a known issue. This saves a lot of time/work for developers and volunteers that could be spending said time making FreeCAD even more awesome.
|
||
</p>
|
||
<h2><span class="mw-headline" id="Reporting_bugs">Reporting bugs</span></h2>
|
||
<p>If you think you might have found a bug, you are welcome to report it as long as you have followed our step-by-step guidelinesː
|
||
</p>
|
||
<ul><li> Make sure you're using the most up to date version of FreeCAD. <b>NOTEː</b> your bug may be fixed in the Development (unstable) version. The average user runs the stable version of FC. </li>
|
||
<li> Make sure your bug is really a bug, that is, something that should be working but isn't. <b>Make sure the same bug hasn't been reported before by first searching the bugtracker and forum</b>.
|
||
<ul><li> Rememberː if you aren't sure, please don't hesitate to explain your problem/bug in the <a rel="nofollow" class="external text" href="http://forum.freecadweb.org/viewforum.php?f=3">Help forum</a> and ask what to do.</li>
|
||
<li> <b>Note</b>ː before posting to the forum please read the <a rel="nofollow" class="external text" href="https://forum.freecadweb.org/viewtopic.php?f=3&t=2264">Forum Guidelines</a>. </li></ul></li>
|
||
<li> Describe as clearly as possible the problem, and how it can be reproduced. If we can not verify the bug, we might not be able to fix it.
|
||
<ul><li> This means <b>reporting in a clear, well-formatted, step-by-step fashion</b> so even an amateur user could reproduce. </li>
|
||
<li> Recommendedː <b>Screenshots</b> of the bug are also very helpful to include. Windows users: please do not attach screen captures in Word or PDF format. Use the Windows Snipping tool to save your capture as a PNG image. </li>
|
||
<li> Recommendedː Even better, an <b>Animated gif or Screencast</b> would also increase the likelihood of reproducing the issue. </li></ul></li>
|
||
<li> <b>Add an example FreeCAD file</b> (.FCStd file) so devs/testers can quickly reproduce the bug.
|
||
<ul><li> Please don't zip your *.FCStd file, it is already zipped. </li>
|
||
<li> File attachments are limited in size. If your *.FCStd file is too big to attach, you can use an online storage service (many are free like Google Drive, Microsoft OneDrive, Dropbox).</li></ul></li>
|
||
<li> Include all the information from the "Copy to Clipboard" button in the <b>Help (menu) -> About FreeCAD</b> dialogue. Make sure your data includes your OCC or OCE version. </li>
|
||
<li> Please file one separate report for each bug.</li>
|
||
<li> If your bug causes a crash in FreeCAD and you're on a system that supports it you can try running a <b>debug backtrace</b> and attach said trace to the ticket. This can save devs a lot of time pinpointing the source of the crash. See <a href="Debugging.html" title="Debugging">Debugging</a> for more details.</li></ul>
|
||
<h2><span class="mw-headline" id="Requesting_features">Requesting features</span></h2>
|
||
<p>If you want something to appear in FreeCAD that is not implemented yet, <u>it is not a bug but a feature request</u>.
|
||
</p>
|
||
<ol><li> <b>IMPORTANTː</b> Before requesting a potential Feature Request <b>please be certain that you are the first one doing so by searching the forums and the bugtracker</b>. If you have concluded that there are no pre-existing tickets/discussions the next step is toː </li>
|
||
<li> Start a forum thread to discuss your feature request with the community via the <a rel="nofollow" class="external text" href="http://forum.freecadweb.org/viewforum.php?f=8">Open Discussion forum</a>. </li>
|
||
<li> Once the community agrees that this is a valid Feature, you then can open a ticket on the tracker (file it under <i>feature request</i> instead of <i>bug</i>). </li></ol>
|
||
<ul><li> <b>NOTE #1</b> To keep things organized please remember to link the forum thread URL into the ticket and the ticket number (as a link) in to the forum thread. </li>
|
||
<li> <b>NOTE #2</b> Keep in mind there are no guarantees that your wish will be fulfilled. </li></ul>
|
||
<div class="thumb tright"><div class="thumbinner" style="width:302px;"><a href="https://www.freecadweb.org/wiki/index.php?title=File:MantisBT-setting-Feature-Request.jpg" class="image"><img alt="" src="300px-MantisBT-setting-Feature-Request.jpg" width="300" height="219" class="thumbimage" srcset="/wiki/images/thumb/b/bb/MantisBT-setting-Feature-Request.jpg/450px-MantisBT-setting-Feature-Request.jpg 1.5x, /wiki/images/thumb/b/bb/MantisBT-setting-Feature-Request.jpg/600px-MantisBT-setting-Feature-Request.jpg 2x" /></a> <div class="thumbcaption"><div class="magnify"><a href="https://www.freecadweb.org/wiki/index.php?title=File:MantisBT-setting-Feature-Request.jpg" class="internal" title="Enlarge"></a></div>FreeCAD Bugtracker report page - use the dropdown to correctly designate what the ticket is</div></div></div>
|
||
<h2><span class="mw-headline" id="Submitting_patches">Submitting patches</span></h2>
|
||
<p>In case you have programmed a bug fix, an extension or something else that can be of public use in FreeCAD, create a patch using the Git diff tool and submit it on the same tracker (file it as <i>patch</i>).
|
||
</p><p>Addendumː FreeCAD development has switched to the <a rel="nofollow" class="external text" href="https://github.com/FreeCAD/FreeCAD">GitHub</a> development model so the workflow for submitting patches has been greatly enhanced/streamlined by submitting Pull Requests.
|
||
</p>
|
||
<ul><li> Open a forum thread in the Developer subforum to announce and discuss your patch. </li>
|
||
<li> Submit your PR to the <a rel="nofollow" class="external text" href="http://github.com/FreeCAD/FreeCAD">FreeCAD GitHub repo</a>. Be sure to link the forum thread in to the git commit summary. </li>
|
||
<li> Paste the PR link in to the forum thread for the devs/testers to test. </li>
|
||
<li> Be present for the discussion so that your code can potentially be merged more effectively. </li></ul>
|
||
<p><b>NOTEː</b> the FreeCAD community recommends to first discuss any large revision to the source code in advance to save everyone time.
|
||
</p>
|
||
<h2><span class="mw-headline" id="Requesting_merge">Requesting merge</span></h2>
|
||
<p>(Same guidelines as <a rel="nofollow" class="external text" href="https://www.freecadweb.org/wiki/Tracker#Submitting_patches">Submiting patches</a>)
|
||
</p><p>If you have created a git branch containing changes that you would like to see merged into the FreeCAD code, you can ask there to have your branch reviewed and merged if the FreeCAD developers are OK with it. You must first publish your branch to a public git repository (github, gitlab, bitbucket, sourceforge etc...) and then give the URL of your branch in your merge request.
|
||
</p>
|
||
<h2><span class="mw-headline" id="MantisBT_Tips_and_Tricks">MantisBT Tips and Tricks</span></h2>
|
||
<h3><span class="mw-headline" id="MantisBT_Markup">MantisBT Markup</span></h3>
|
||
<p>MantisBT (Mantis Bug Tracker) has it's own unique markup.
|
||
</p>
|
||
<ul><li> <b>@</b>mention - works just like on GitHub where if you prepend '@' to someone's username they will receive an email that they have been 'mentioned' in a ticket thread</li></ul>
|
||
<div class="center"><div class="floatnone"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Mantisbt-mention-example.jpg" class="image"><img alt="Mantisbt-mention-example.jpg" src="600px-Mantisbt-mention-example.jpg" width="600" height="70" srcset="/wiki/images/thumb/b/ba/Mantisbt-mention-example.jpg/900px-Mantisbt-mention-example.jpg 1.5x, /wiki/images/b/ba/Mantisbt-mention-example.jpg 2x" /></a></div></div>
|
||
<ul><li> <b>#</b>1234 - By adding a hash tag in front of a number a shortcut to link to another ticket within MantisBT will present.
|
||
<dl><dd> <b>Note</b>: if you hover over a ticket it will show you the summary + if the ticket is closed, it will be struck-through like <s>#1234</s>.</dd></dl></li></ul>
|
||
<div class="center"><div class="floatnone"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Mantisbt-ticket-shortcut-example.jpg" class="image"><img alt="Mantisbt-ticket-shortcut-example.jpg" src="600px-Mantisbt-ticket-shortcut-example.jpg" width="600" height="112" srcset="/wiki/images/4/47/Mantisbt-ticket-shortcut-example.jpg 1.5x" /></a></div></div>
|
||
<ul><li> <b>~</b>5678 - a shortcut that links to a bug note within a ticket. This can be used to reference someone's response within the thread. Each person that posts will show a unique ~#### number next to their username. If you look at the image in the example, you see that the shortcut is referencing the <i>ticket number:comment number</i> of said ticket</li></ul>
|
||
<div class="center"><div class="floatnone"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Mantisbt-comment-shortcut-example.jpg" class="image"><img alt="Mantisbt-comment-shortcut-example.jpg" src="600px-Mantisbt-comment-shortcut-example.jpg" width="600" height="74" srcset="/wiki/images/thumb/2/23/Mantisbt-comment-shortcut-example.jpg/900px-Mantisbt-comment-shortcut-example.jpg 1.5x, /wiki/images/thumb/2/23/Mantisbt-comment-shortcut-example.jpg/1200px-Mantisbt-comment-shortcut-example.jpg 2x" /></a></div></div>
|
||
<ul><li> <b><del></del></b> - Using these tags will <s>strikeout text</s>. </li></ul>
|
||
<div class="center"><div class="floatnone"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Mantisbt-strikeout-text-example.jpg" class="image"><img alt="Mantisbt-strikeout-text-example.jpg" src="600px-Mantisbt-strikeout-text-example.jpg" width="600" height="30" srcset="/wiki/images/thumb/4/49/Mantisbt-strikeout-text-example.jpg/900px-Mantisbt-strikeout-text-example.jpg 1.5x, /wiki/images/4/49/Mantisbt-strikeout-text-example.jpg 2x" /></a></div></div>
|
||
<ul><li> <b><code></code></b> - To present a line or block of code, use this tag and it will colorize and differentiate it elegantly. </li></ul>
|
||
<div class="center"><div class="floatnone"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Mantisbt-colorized-code-example.jpg" class="image"><img alt="Mantisbt-colorized-code-example.jpg" src="600px-Mantisbt-colorized-code-example.jpg" width="600" height="191" srcset="/wiki/images/thumb/f/f3/Mantisbt-colorized-code-example.jpg/900px-Mantisbt-colorized-code-example.jpg 1.5x, /wiki/images/thumb/f/f3/Mantisbt-colorized-code-example.jpg/1200px-Mantisbt-colorized-code-example.jpg 2x" /></a></div></div>
|
||
<h3><span class="mw-headline" id="MantisBT_BBCode">MantisBT BBCode</span></h3>
|
||
<p>In addition to the above <a href="https://www.freecadweb.org/wiki/index.php?title=Tracker/MantisBT_%CC%A0Markup&action=edit&redlink=1" class="new" title="Tracker/MantisBT ̠Markup (page does not exist)">Tracker/MantisBT ̠Markup</a> one also has the possibility to use BBCode format. For a comprehensive list see the <a rel="nofollow" class="external text" href="https://github.com/mantisbt-plugins/BBCodePlus#supported-bbcode-tags">BBCode plus plugin page</a>. Here is a list of supported BBCode tagsː
|
||
<small><code><br />
|
||
[img][/img] - Images <br />
|
||
[url][/url] - Links <br />
|
||
[email][/email] - Email addresses <br />
|
||
[color=red][/color] - Colored text <br />
|
||
[highlight=yellow][/highlight] - Highlighted text <br />
|
||
[size][/size] - Font size <br />
|
||
[list][/list] - Lists <br />
|
||
[list=1][/list] - Numbered lists (number is starting number) <br />
|
||
[*] - List items <br />
|
||
[b][/b] - Bold <br />
|
||
[u][/u] - underline <br />
|
||
[i][/i] - Italic <br />
|
||
[s][/s] - Strikethrough <br />
|
||
[left][/left] - Left align <br />
|
||
[center][/center] - Center <br />
|
||
[right][/right] - Right align <br />
|
||
[justify][/justify] - Justify <br />
|
||
[hr] - Horizontal rule <br />
|
||
[sub][/sub] - Subscript <br />
|
||
[sup][/sup] - Superscript <br />
|
||
[table][/table] - Table <br />
|
||
[table=1][/table] - Table with border of specified width <br />
|
||
[tr][/tr] - Table row <br />
|
||
[td][/td] - Table column <br />
|
||
[code][/code] - Code block <br />
|
||
[code=sql][/code] - Code block with language definition <br />
|
||
[code start=3][/code] - Code block with line numbers starting at number <br />
|
||
[quote][/quote] - Quote by *someone* (no name) <br />
|
||
[quote=name][/quote] - Quote by *name* <br />
|
||
</code>
|
||
</small>
|
||
</p>
|
||
<h3><span class="mw-headline" id="MantisBT_.3C.3D.3E_GitHub_Markup">MantisBT <=> GitHub Markup</span></h3>
|
||
<p>Below are special MantisBT Source-Integration plugin keywords which will link to the FreeCAD GitHub repo. See <a href="/wiki/Tracker#GitHub_and_MantisBT" title="Tracker">Tracker#GitHub_and_MantisBT</a>.
|
||
</p>
|
||
<ul><li> <b>c:FreeCAD:git commit hash:</b> - <b>c</b> stands for 'commit'. FreeCAD stands for the FreeCAD GitHub repo. 'git commit hash' is the specific git commit hash to reference. Note: the trailing colon is necessary. Exampleː <code>cːFreeCADː709d2f325db0490016807b8fa6f49d1c867b6bd8ː</code> </li>
|
||
<li> <b>d:FreeCAD:git commit hash:</b> - similar to the above, <b>d</b> stands for 'diff' which will provide a Diff view of the commit. Exampleː <code>dːFreeCADː709d2f325db0490016807b8fa6f49d1c867b6bd8ː</code> </li>
|
||
<li> <b>p:FreeCAD:pullrequest:</b> - similar to the above, <b>p</b> stands for Pull Request. Exampleː <code>pːFreeCADː498ː</code> </li></ul>
|
||
<div class="center"><div class="floatnone"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Mantisbt-source-integration-markup.jpg" class="image"><img alt="Mantisbt-source-integration-markup.jpg" src="600px-Mantisbt-source-integration-markup.jpg" width="600" height="75" srcset="/wiki/images/2/20/Mantisbt-source-integration-markup.jpg 1.5x" /></a></div></div>
|
||
<div style="clear:both"></div>
|
||
<p><br />
|
||
</p>
|
||
<h2><span class="mw-headline" id="GitHub_and_MantisBT">GitHub and MantisBT</span></h2>
|
||
<p>The FreeCAD bugtracker has a plug-in called <a rel="nofollow" class="external text" href="https://github.com/mantisbt-plugins/source-integration">Source Integration</a> which essentially ties both the FreeCAD GitHub repo to our MantisBT tracker. It makes it easier to track and associate git commits with their respective MantisBT tickets. <b>The Source Integration plugin scans the git commit messages for specific keywords in order to execute the following actions:</b>
|
||
</p><p><b>Note</b> The below keywords need to be added in the <u>git commit message</u> and not the PR subject
|
||
</p>
|
||
<h3><span class="mw-headline" id="Attaching_a_git_commit_to_a_ticket">Attaching a git commit to a ticket</span></h3>
|
||
<p>The format MantisBT will recognize:
|
||
</p>
|
||
<ul><li> bug #1234</li>
|
||
<li> bugs #1234, #5678</li>
|
||
<li> issue #1234</li>
|
||
<li> issues #1234, #5678</li>
|
||
<li> report #1234</li>
|
||
<li> reports #1234, #5678</li></ul>
|
||
<p><small>For the inquisitive here is the regex MantisBT uses for this operation: <br />
|
||
<code>/(?:bugs?|issues?|reports?)+\s*:?\s+(?:#(?:\d+)[,\.\s]*)+/i</code></small>
|
||
</p>
|
||
<h3><span class="mw-headline" id="Remotely_resolving_a_ticket">Remotely resolving a ticket</span></h3>
|
||
<p>The format MantisBT will recognize:
|
||
</p>
|
||
<ul><li> fix #1234</li>
|
||
<li> fixed #1234</li>
|
||
<li> fixes #1234</li>
|
||
<li> fixed #1234, #5678</li>
|
||
<li> fixes #1234, #5678</li>
|
||
<li> resolve #1234</li>
|
||
<li> resolved #1234</li>
|
||
<li> resolves #1234</li>
|
||
<li> resolved #1234, #5678</li>
|
||
<li> resolves #1234, #5678</li></ul>
|
||
<p><small>For the inquisitive here is the regex MantisBT uses for this operation: <br />
|
||
<code>/(?:fixe?d?s?|resolved?s?)+\s*:?\s+(?:#(?:\d+)[,\.\s]*)+/i</code></small>
|
||
</p>
|
||
<h2><span class="mw-headline" id="Related">Related</span></h2>
|
||
<ul><li> <a href="Bug_Triage.html" title="Bug Triage">Bug Triage</a></li>
|
||
<li> <a href="Source_Code_Management.html" class="mw-redirect" title="Source Code Management">Source Code Management</a></li></ul>
|
||
|
||
<div style="clear:both"></div>
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div><div class="printfooter">
|
||
Online version: "<a dir="ltr" href="https://www.freecadweb.org/wiki/index.php?title=Tracker&oldid=242108">http://www.freecadweb.org/wiki/index.php?title=Tracker&oldid=242108</a>"</div>
|
||
<div id="catlinks" class="catlinks" data-mw="interface"></div><div class="visualClear"></div>
|
||
</div>
|
||
</div>
|
||
<div id="mw-navigation">
|
||
<h2>Navigation menu</h2>
|
||
|
||
</body></html> |