120 lines
14 KiB
HTML
120 lines
14 KiB
HTML
<html><head><title>Tracker/pt</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>Tracker/pt</h1></div>
|
||
|
||
<div id="mw-content-text" lang="pt" dir="ltr" class="mw-content-ltr"><hr/><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>There you can report bugs, submit feature requests, patches, or request to merge your branch if you developed something using git. The tracker is divided into modules, so please be specific and file your request in the appropriate subsection. In case of doubt, leave it in the "FreeCAD" section.
|
||
</p><p>Please before creating tickets, always first discuss bugs in the <a rel="nofollow" class="external text" href="http://forum.freecadweb.org/viewforum.php?f=3">Help forum</a> and feature requests in the <a rel="nofollow" class="external text" href="http://forum.freecadweb.org/viewforum.php?f=8">Open discussion forum</a>.
|
||
</p>
|
||
<div id="toc" class="toc"><div class="toctitle"><h2>Contents</h2></div>
|
||
<ul>
|
||
<li class="toclevel-1 tocsection-1"><a href="#Reporting_bugs"><span class="tocnumber">1</span> <span class="toctext">Reporting bugs</span></a></li>
|
||
<li class="toclevel-1 tocsection-2"><a href="#Requesting_features"><span class="tocnumber">2</span> <span class="toctext">Requesting features</span></a></li>
|
||
<li class="toclevel-1 tocsection-3"><a href="#Submitting_patches"><span class="tocnumber">3</span> <span class="toctext">Submitting patches</span></a></li>
|
||
<li class="toclevel-1 tocsection-4"><a href="#Requesting_merge"><span class="tocnumber">4</span> <span class="toctext">Requesting merge</span></a></li>
|
||
<li class="toclevel-1 tocsection-5"><a href="#MantisBT_Tips_and_Tricks"><span class="tocnumber">5</span> <span class="toctext">MantisBT Tips and Tricks</span></a>
|
||
<ul>
|
||
<li class="toclevel-2 tocsection-6"><a href="#MantisBT_.3C.3D.3E_GitHub_Markup"><span class="tocnumber">5.1</span> <span class="toctext">MantisBT <=> GitHub Markup</span></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toclevel-1 tocsection-7"><a href="#GitHub_and_MantisBT"><span class="tocnumber">6</span> <span class="toctext">GitHub and MantisBT</span></a>
|
||
<ul>
|
||
<li class="toclevel-2 tocsection-8"><a href="#Attaching_a_git_commit_to_a_ticket"><span class="tocnumber">6.1</span> <span class="toctext">Attaching a git commit to a ticket</span></a></li>
|
||
<li class="toclevel-2 tocsection-9"><a href="#Remotely_resolving_a_ticket"><span class="tocnumber">6.2</span> <span class="toctext">Remotely resolving a ticket</span></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<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 there so long as you have first discussed the matter in the appropriate forum. But before reporting a bug, please check the following items:
|
||
</p>
|
||
<ul><li> Make sure your bug is really a bug, that is, something that should be working and that is not working. If you are not sure, don't hesitate to explain your problem on the <a rel="nofollow" class="external text" href="http://forum.freecadweb.org/">forum</a> and ask what to do.</li>
|
||
<li> Before submitting anything, read the <a href="FAQ.html" title="FAQ">frequently asked questions</a>, do a search on the <a rel="nofollow" class="external text" href="http://forum.freecadweb.org/">forum</a>, and make sure the same bug hasn't been reported before, by doing a search on the bug tracker.</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.</li>
|
||
<li> Include all the information from the "Copy to Clipboard" button in the Help (menu) -> About FreeCAD dialogue and do so from either the Part or PartDesign workbench so that your data will include your OCC or OCE version. </li>
|
||
<li> Please file one separate report for each bug.</li>
|
||
<li> If you are on a linux system and your bug causes a crash in FreeCAD, you can try running a debug backtrace: From a terminal run <i>gdb freecad</i> (assuming package gdb is installed), then, inside gdb, type <i>run</i> . FreeCAD will then run. After the crash happens, type <i>bt</i> , to get the full backtrace. Include that backtrace in your bug report.</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>. You can also submit it on the same tracker (file it under <i>feature request</i> instead of bug), but keep in mind there are no guarantees that your wish will be fulfilled.
|
||
</p>
|
||
<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 patch).
|
||
</p>
|
||
<h2><span class="mw-headline" id="Requesting_merge">Requesting merge</span></h2>
|
||
<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,bitbucket, sourceforge...) 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>
|
||
<p>MantisBT (Mantis Bug Tracker) has it's own unique markup. Here is a list of useful ones:
|
||
</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_.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>
|
||
|
||
<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/pt&oldid=230401">http://www.freecadweb.org/wiki/index.php?title=Tracker/pt&oldid=230401</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> |