From FreeCAD Documentation
Revision as of 18:21, 19 February 2017 by Renatorivo (talk | contribs) (Marked this version for translation)
Jump to navigation Jump to search

The adress of our bug tracker is:

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.

Please before creating tickets, always first discuss bugs in the Help forum and feature requests in the Open discussion forum.

Reporting bugs

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:

  • 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 forum and ask what to do.
  • Before submitting anything, read the frequently asked questions, do a search on the forum, and make sure the same bug hasn't been reported before, by doing a search on the bug tracker.
  • 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.
  • 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.
  • Please file one separate report for each bug.
  • 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.

Requesting features

If you want something to appear in FreeCAD that is not implemented yet, it is not a bug but a feature request. You can also submit it on the same tracker (file it as feature request instead of bug), but keep in mind there are no guarantees that your wish will be fulfilled.

Submitting patches

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).

Requesting merge

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.

MantisBT Tips and Tricks

MantisBT (Mantis Bug Tracker) has it's own unique markup. Here is a list of useful ones:

  • @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 - a shortcut to link to another ticket within MantisBT
  • ~5678 - a shortcut that links to a specific thread 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.
  • c:FreeCAD:git commit:: Part of the MantisBT Source-Integration plugin which will link to the FreeCAD GitHub git commit. c stands for 'commit'. FreeCAD stands for the FC GitHub repo. 'git commit' is the specific git commit hash to reference. Note: the trailing colon is necessary.
  • d:FreeCAD:diff: similar to the above, but shows the diff
  • p:FreeCAD:pullrequest: similar to the above but should show the Pull Request.
  • <del></del> will strikeout text
  • <code></code> will represent a block of colorized code
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎русский • ‎中文 • ‎中文(中国大陆)‎ • ‎日本語