Tracker/sv: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
Adressen till vår bug tracker är:


{{Docnav
http://www.freecadweb.org/tracker
|[[Third_Party_Tools|Third Party Tools]]
|[[Debugging|Debugging]]
}}


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


{{VeryImportantMessage|In February 2022 FreeCAD bug tracking was migrated to [https://github.com/FreeCAD/FreeCAD/issues GitHub Issues]. The Mantis bug tracker described below is now in read-only mode.}}
Please before creating tickets, always first discuss bugs in the [http://forum.freecadweb.org/viewforum.php?f=3 Help forum] and feature requests in the [http://forum.freecadweb.org/viewforum.php?f=8 Open discussion forum].


[[File:Mantis_logo_262x90.png|center|link=https://freecadweb.org/tracker/MantisBT is the bugtracker framework FreeCAD uses]]

The [https://www.freecadweb.org/tracker FreeCAD BugTracker] 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.


== Recommended Workflow ==
[[File:Bugreport-workflow.png|center]]

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.

<span id="Reporting_bugs"></span>
== Rapportera buggar ==
== Rapportera buggar ==


<div class="mw-translate-fuzzy">
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:
Om du tror att du funnit en bugg, så är du välkommen att rapportera den där. Men innan du rapporterar en bugg, kontrollera följande punkter:
</div>


<div class="mw-translate-fuzzy">
* 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 [http://forum.freecadweb.org/ forum] and ask what to do.
* Försäkra dig om att din bugg verkligen är en bugg, vilket är något som ska fungera men inte fungerar. Om du inte är säker, tveka inte att förklara ditt problem på [http://forum.freecadweb.org/ forumet] och fråga vad du ska göra.
* Before submitting anything, read the [[FAQ|frequently asked questions]], do a search on the [http://forum.freecadweb.org/ forum], and make sure the same bug hasn't been reported before, by doing a search on the bug tracker.
* Innan du skickar något, läs [[Frequently_asked_questions/sv|ofta ställda frågor]], gör en sökning på [http://forum.freecadweb.org/ forumet], och försäkra dig om att buggen inte har rapporterats innan , genom att söka i bug trackern.
* 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.
* Beskriv problemet så klart och noggrant som möjkligt, och hur det kan reproduceras. Om vi inte kan verifiera buggen, så kanske vi inte kan fixa den.
* 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.
* Skicka med följande information: Ditt operativsystem, om det är 32 eller 64 bitars, och vilken FreeCAD version du kör.
* Please file one separate report for each bug.
* Var snäll och posta en separat rapport för varje bugg.
* 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 ''gdb freecad'' (assuming package gdb is installed), then, inside gdb, type ''run'' . FreeCAD will then run. After the crash happens, type ''bt'' , to get the full backtrace. Include that backtrace in your bug report.
* Om du är på ett linuxsystem och din bugg orsakar en krasch i FreeCAD, så kan du försöka köra en debug backtrace: Från en terminal så kör du ''gdb freecad'' (med antagandet att paketet gdb är installerat), sedan, inuti gdb, skriv ''run'' . FreeCAD kommer att starta. Efter att kraschen har uppstått , skriv ''bt'' , för att få hela backtracen. Inkludera denna backtrace i din buggrapport.
</div>


<span id="Requesting_features"></span>
== Begära funktioner ==
== Begära funktioner ==


<div class="mw-translate-fuzzy">
Om du vill ha något i FreeCAD som inte finns ännu, så är detta inte en bugg utan en funktionsbegäran. Du kan också skicka den på samma tracker (posta den som en funktionsbegäran istället för bugg), men tänk på att det finns inga garantier att din önskan blir uppfylld.
Om du vill ha något i FreeCAD som inte finns ännu, så är detta inte en bugg utan en funktionsbegäran. Du kan också skicka den på samma tracker (posta den som en funktionsbegäran istället för bugg), men tänk på att det finns inga garantier att din önskan blir uppfylld.
</div>


# '''IMPORTANTː''' Before requesting a potential Feature Request '''please be certain that you are the first one doing so by searching the forums and the bugtracker'''. If you have concluded that there are no pre-existing tickets/discussions the next step is toː
# Start a forum thread to discuss your feature request with the community via the [http://forum.freecadweb.org/viewforum.php?f=8 Open Discussion forum].
# Once the community agrees that this is a valid Feature, you then can open a ticket on the tracker (file it under ''feature request'' instead of ''bug'').
* '''NOTE #1''' 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.
* '''NOTE #2''' Keep in mind there are no guarantees that your wish will be fulfilled.
[[File:MantisBT-setting-Feature-Request.jpg|thumb|FreeCAD Bugtracker report page - use the dropdown to correctly designate what the ticket is]]

<span id="Submitting_patches"></span>
== Skicka patchar ==
== Skicka patchar ==


<div class="mw-translate-fuzzy">
Om du har programmerat en buggfix, en extension eller något annat som kan vara allmänt gångbart i FreeCAD, skapa en patch genom att använda Subversion's diff verktyg och posta den på samma tracker (posta den som en patch).
Om du har programmerat en buggfix, en extension eller något annat som kan vara allmänt gångbart i FreeCAD, skapa en patch genom att använda Subversion's diff verktyg och posta den på samma tracker (posta den som en patch).
</div>


== Requesting merge ==
== Requesting merge ==


(Same guidelines as [https://www.freecadweb.org/wiki/Tracker#Submitting_patches Submiting patches])
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.


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.
{{docnav/sv|Licence/sv|CompileOnWindows/sv}}


== MantisBT Tips and Tricks ==
[[Category:Developer Documentation/sv]]


=== MantisBT Markup ===
MantisBT (Mantis Bug Tracker) has it's own unique markup.
* '''@'''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
[[File:mantisbt-mention-example.jpg|center|600px]]
* '''#'''1234 - By adding a hash tag in front of a number a shortcut to link to another ticket within MantisBT will present.
*: '''Note''': 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>.
[[File:mantisbt-ticket-shortcut-example.jpg|center|600px]]
* '''~'''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 ''ticket number:comment number'' of said ticket
[[File:mantisbt-comment-shortcut-example.jpg|center|600px]]
* '''<nowiki><del></del></nowiki>''' - Using these tags will <s>strikeout text</s>.
[[File:mantisbt-strikeout-text-example.jpg|center|600px]]
* '''<nowiki><code></code></nowiki>''' - To present a line or block of code, use this tag and it will colorize and differentiate it elegantly.
[[File:mantisbt-colorized-code-example.jpg|center|600px]]

=== MantisBT BBCode ===
In addition to the above [[Tracker#MantisBT_Markup|MantisBT Markup]] one also has the possibility to use BBCode format. For a comprehensive list see the [https://github.com/mantisbt-plugins/BBCodePlus#supported-bbcode-tags BBCode plus plugin page]. 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>

=== MantisBT <=> GitHub Markup ===
Below are special MantisBT Source-Integration plugin keywords which will link to the FreeCAD GitHub repo. See [[Tracker#GitHub_and_MantisBT|GitHub and MantisBT]].
* '''c:FreeCAD:git commit hash:''' - '''c''' 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>
* '''d:FreeCAD:git commit hash:''' - similar to the above, '''d''' stands for 'diff' which will provide a Diff view of the commit. Exampleː <code>dːFreeCADː709d2f325db0490016807b8fa6f49d1c867b6bd8ː</code>
* '''p:FreeCAD:pullrequest:''' - similar to the above, '''p''' stands for Pull Request. Exampleː <code>pːFreeCADː498ː</code>
[[File:mantisbt-source-integration-markup.jpg|center|600px]]
{{clear}}
{{clear}}

<languages/>
== GitHub and MantisBT ==
The FreeCAD bugtracker has a plug-in called [https://github.com/mantisbt-plugins/source-integration Source Integration] 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. '''The Source Integration plugin scans the git commit messages for specific keywords in order to execute the following actions:'''

'''Note''' The below keywords need to be added in the <u>git commit message</u> and not the PR subject

=== Remotely referencing a ticket ===
Using this pattern will automagically associate a git commit to a ticket ('''Note:''' this will not close the ticket.)
The format MantisBT will recognize:
* bug #1234
* bugs #1234, #5678
* issue #1234
* issues #1234, #5678
* report #1234
* reports #1234, #5678
<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>

=== Remotely resolving a ticket ===
The format MantisBT will recognize:
* fix #1234
* fixed #1234
* fixes #1234
* fixed #1234, #5678
* fixes #1234, #5678
* resolve #1234
* resolved #1234
* resolves #1234
* resolved #1234, #5678
* resolves #1234, #5678
<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>


<div class="mw-translate-fuzzy">
{{Docnav/sv
|[[Third_Party_Tools/sv|Third Party Tools]]
|[[Bug_Triage/sv|Bug Triage]]
}}
</div>

{{Userdocnavi{{#translation:}}}}
[[Category:Developer Documentation{{#translation:}}]]
[[Category:Administration{{#translation:}}]]

Latest revision as of 21:42, 21 November 2023

In February 2022 FreeCAD bug tracking was migrated to GitHub Issues. The Mantis bug tracker described below is now in read-only mode.
link=https://freecadweb.org/tracker/MantisBT is the bugtracker framework FreeCAD uses
link=https://freecadweb.org/tracker/MantisBT is the bugtracker framework FreeCAD uses

The FreeCAD BugTracker 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.


Recommended Workflow

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.

Rapportera buggar

Om du tror att du funnit en bugg, så är du välkommen att rapportera den där. Men innan du rapporterar en bugg, kontrollera följande punkter:

  • Försäkra dig om att din bugg verkligen är en bugg, vilket är något som ska fungera men inte fungerar. Om du inte är säker, tveka inte att förklara ditt problem på forumet och fråga vad du ska göra.
  • Innan du skickar något, läs ofta ställda frågor, gör en sökning på forumet, och försäkra dig om att buggen inte har rapporterats innan , genom att söka i bug trackern.
  • Beskriv problemet så klart och noggrant som möjkligt, och hur det kan reproduceras. Om vi inte kan verifiera buggen, så kanske vi inte kan fixa den.
  • Skicka med följande information: Ditt operativsystem, om det är 32 eller 64 bitars, och vilken FreeCAD version du kör.
  • Var snäll och posta en separat rapport för varje bugg.
  • Om du är på ett linuxsystem och din bugg orsakar en krasch i FreeCAD, så kan du försöka köra en debug backtrace: Från en terminal så kör du gdb freecad (med antagandet att paketet gdb är installerat), sedan, inuti gdb, skriv run . FreeCAD kommer att starta. Efter att kraschen har uppstått , skriv bt , för att få hela backtracen. Inkludera denna backtrace i din buggrapport.

Begära funktioner

Om du vill ha något i FreeCAD som inte finns ännu, så är detta inte en bugg utan en funktionsbegäran. Du kan också skicka den på samma tracker (posta den som en funktionsbegäran istället för bugg), men tänk på att det finns inga garantier att din önskan blir uppfylld.

  1. IMPORTANTː Before requesting a potential Feature Request please be certain that you are the first one doing so by searching the forums and the bugtracker. If you have concluded that there are no pre-existing tickets/discussions the next step is toː
  2. Start a forum thread to discuss your feature request with the community via the Open Discussion forum.
  3. Once the community agrees that this is a valid Feature, you then can open a ticket on the tracker (file it under feature request instead of bug).
  • NOTE #1 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.
  • NOTE #2 Keep in mind there are no guarantees that your wish will be fulfilled.
FreeCAD Bugtracker report page - use the dropdown to correctly designate what the ticket is

Skicka patchar

Om du har programmerat en buggfix, en extension eller något annat som kan vara allmänt gångbart i FreeCAD, skapa en patch genom att använda Subversion's diff verktyg och posta den på samma tracker (posta den som en patch).

Requesting merge

(Same guidelines as Submiting patches)

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.

MantisBT Tips and Tricks

MantisBT Markup

MantisBT (Mantis Bug Tracker) has it's own unique markup.

  • @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
  • #1234 - By adding a hash tag in front of a number a shortcut to link to another ticket within MantisBT will present.
    Note: if you hover over a ticket it will show you the summary + if the ticket is closed, it will be struck-through like #1234.
  • ~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 ticket number:comment number of said ticket
  • <del></del> - Using these tags will strikeout text.
  • <code></code> - To present a line or block of code, use this tag and it will colorize and differentiate it elegantly.

MantisBT BBCode

In addition to the above MantisBT Markup one also has the possibility to use BBCode format. For a comprehensive list see the BBCode plus plugin page. Here is a list of supported BBCode tagsː
[img][/img] - Images
[url][/url] - Links
[email][/email] - Email addresses
[color=red][/color] - Colored text
[highlight=yellow][/highlight] - Highlighted text
[size][/size] - Font size
[list][/list] - Lists
[list=1][/list] - Numbered lists (number is starting number)
[*] - List items
[b][/b] - Bold
[u][/u] - underline
[i][/i] - Italic
[s][/s] - Strikethrough
[left][/left] - Left align
[center][/center] - Center
[right][/right] - Right align
[justify][/justify] - Justify
[hr] - Horizontal rule
[sub][/sub] - Subscript
[sup][/sup] - Superscript
[table][/table] - Table
[table=1][/table] - Table with border of specified width
[tr][/tr] - Table row
[td][/td] - Table column
[code][/code] - Code block
[code=sql][/code] - Code block with language definition
[code start=3][/code] - Code block with line numbers starting at number
[quote][/quote] - Quote by *someone* (no name)
[quote=name][/quote] - Quote by *name*

MantisBT <=> GitHub Markup

Below are special MantisBT Source-Integration plugin keywords which will link to the FreeCAD GitHub repo. See GitHub and MantisBT.

  • c:FreeCAD:git commit hash: - c 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ː cːFreeCADː709d2f325db0490016807b8fa6f49d1c867b6bd8ː
  • d:FreeCAD:git commit hash: - similar to the above, d stands for 'diff' which will provide a Diff view of the commit. Exampleː dːFreeCADː709d2f325db0490016807b8fa6f49d1c867b6bd8ː
  • p:FreeCAD:pullrequest: - similar to the above, p stands for Pull Request. Exampleː pːFreeCADː498ː

GitHub and MantisBT

The FreeCAD bugtracker has a plug-in called Source Integration 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. The Source Integration plugin scans the git commit messages for specific keywords in order to execute the following actions:

Note The below keywords need to be added in the git commit message and not the PR subject

Remotely referencing a ticket

Using this pattern will automagically associate a git commit to a ticket (Note: this will not close the ticket.) The format MantisBT will recognize:

  • bug #1234
  • bugs #1234, #5678
  • issue #1234
  • issues #1234, #5678
  • report #1234
  • reports #1234, #5678

For the inquisitive here is the regex MantisBT uses for this operation:
/(?:bugs?|issues?|reports?)+\s*:?\s+(?:#(?:\d+)[,\.\s]*)+/i

Remotely resolving a ticket

The format MantisBT will recognize:

  • fix #1234
  • fixed #1234
  • fixes #1234
  • fixed #1234, #5678
  • fixes #1234, #5678
  • resolve #1234
  • resolved #1234
  • resolves #1234
  • resolved #1234, #5678
  • resolves #1234, #5678

For the inquisitive here is the regex MantisBT uses for this operation:
/(?:fixe?d?s?|resolved?s?)+\s*:?\s+(?:#(?:\d+)[,\.\s]*)+/i