Tracker/ja: Difference between revisions

From FreeCAD Documentation
(Created page with "== パッチの投稿 ==")
(Updating to match new version of source page)
 
(35 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
[[File:Mantis_logo_262x90.png|right|link=https://freecadweb.org/tracker/MantisBT is the bugtracker framework FreeCAD uses]]
近年、sourceforgeプラットフォームにより、プロジェクトのバグトラッカーアプリケーション[http://www.mantisbt.org/ mantis bug tracker] が作られ、FreeCADは、古いビルトインのバグトラッカーの代わりに、現在このバグトラッカーを使っています。私たちのバグトラッカーのアドレスは、次のとおりです。:


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


{{TOCright}}

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

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

<div class="mw-translate-fuzzy">
もし、バグを発見したかもと思ったら、そこにバグを報告することは歓迎されます。しかし、バグを報告する前に、以下の項目をチェックしてください。:
もし、バグを発見したかもと思ったら、そこにバグを報告することは歓迎されます。しかし、バグを報告する前に、以下の項目をチェックしてください。:


Line 13: Line 21:
* あなたが使用しているオペレーティングシステムが32bitか64bitか、 あなたが使っているFreeCADのバージョンについての情報を付け加えてください。
* あなたが使用しているオペレーティングシステムが32bitか64bitか、 あなたが使っているFreeCADのバージョンについての情報を付け加えてください。
* バグ毎に個別のレポートを投稿してください。
* バグ毎に個別のレポートを投稿してください。
* FreeCADをinux上で利用し、バグが原因でクラッシュした場合は、デバッグトレースを実行することもできます。端末からgdb freecadを実行(gdbパッケージがインストールされていることを仮定)し、gdbの中でrunを実行します。 FreeCADは実行されます。クラッシュが発生したら、btと入力するとバックトレースを取得できます。投稿するバグレポートの中にバックトレースを含めてください。
* FreeCADをinux上で利用し、バグが原因でクラッシュした場合は、デバッグトレースを実行することもできます。端末からgdb freecadを実行(gdbパッケージがインストールされていることを仮定)し、gdbの中でrunを実行します。 FreeCADは実行されます。クラッシュが発生したら、btと入力するとバックトレースを取得できます。投稿するバグレポートの中にバックトレースを含めてください。
</div>




==フローチャート==
== Recommended Workflow ==
[[File:Bugreport-workflow.png|center]]
[[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.
あるかどうかを確認してください。 これにより、開発者やボランティアにとって、FreeCADをさらにすばらしいものにする時間を節約できます。


<span id="Reporting_bugs"></span>
== Reporting bugs ==
== バグ ==


もし、バグを発見したかもと思ったら、そこにバグを報告することは歓迎されます。しかし、バグを報告する前に、以下の項目をチェックしてください。:
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ː


* Make sure you're using the most up to date version of FreeCAD. '''NOTEː''' your bug may be fixed in the Development (unstable) version. The average user runs the stable version of FC.
* Make sure your bug is really a bug, that is, something that should be working but isn't. '''Make sure the same bug hasn't been reported before by first searching the bugtracker and forum'''.
** Rememberː if you aren't sure, please don't hesitate to explain your problem/bug in the [http://forum.freecadweb.org/viewforum.php?f=3 Help forum] and ask what to do.
** '''Note'''ː before posting to the forum please read the [https://forum.freecadweb.org/viewtopic.php?f=3&t=2264 Forum Guidelines].
* 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.
** This means '''reporting in a clear, well-formatted, step-by-step fashion''' so even an amateur user could reproduce.
** Recommendedː '''Screenshots''' 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.
** Recommendedː Even better, an '''Animated gif or Screencast''' would also increase the likelihood of reproducing the issue.
* '''Add an example FreeCAD file''' (.FCStd file) so devs/testers can quickly reproduce the bug.
** Please don't zip your *.FCStd file, it is already zipped.
** 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).
* Include all the information from the "Copy to Clipboard" button in the '''Help (menu) -> About FreeCAD''' dialogue. Make sure your data includes your OCC or OCE version.
* Please file one separate report for each bug.
* If your bug causes a crash in FreeCAD and you're on a system that supports it you can try running a '''debug backtrace''' and attach said trace to the ticket. This can save devs a lot of time pinpointing the source of the crash. See [[Debugging|Debugging]] for more details.


もしバグを発見したかもしれないと思う場合は、トラッカーの [http://sourceforge.net/tracker/?atid=455298&group_id=49159&func=browse Bugs Section] に行き、statusをanyにして、これまでに申請されたバグを確認してください。キーワード検索を利用すると、似ている問題のバグトラッカーのエントリを見つけることができます。もし、あなたの問題が過去の項目になかったときは、同じページに新たな項目として投稿すべきです。

=== 機能追加要求 ===
あなたがFreeCADを世界で一番のCADソフトウェアにするために絶対に必要と思う機能がないことに気づいたら、[http://sourceforge.net/tracker/?atid=455301&group_id=49159&func=browse Feature Request] 機能追加要望のセクションが役に立つかもしれません。

=== サポート要求 ===
あなたがFreeCADをコンパイルするのにどうすることもできず、 [[Compile_on_Windows/ja|Compile on Windows]] や [[Compile_on_Linux/ja|Compile on Linux]] にヒントとなるものが書かれていない場合や、他の新しい環境への移植を試す場合や、FreeCADの新しいモジュールや拡張機能を作る場合に、補助が必要な場合は、[http://sourceforge.net/tracker/?atid=455299&group_id=49159&func=browse Support Requests] セクションがあなたの行くべき場所になります。

=== 新しいパッチ ===
バグの修正や、拡張機能、一般公開できるFreeCADの何らかを作成したときは、Subversioを使ってパッチを作成し、 [https://sourceforge.net/tracker/?group_id=49159&atid=455300 patches section] セクションにファイルを投稿してください。

<span id="Requesting_features"></span>
== 機能追加要望 ==
== 機能追加要望 ==


実装されていない機能をFreeCADで使いたいと思ったら、それはバグではなく、機能追加要望です。これは同じトラッカー(バグではなく機能要望として申請する)に投稿できますが、あなたの機能追加要望が実現される保証が無いことを心に留めておいてください。
実装されていない機能をFreeCADで使いたいと思ったら、それはバグではなく、機能追加要望です。これは同じトラッカー(バグではなく機能要望として申請する)に投稿できますが、あなたの機能追加要望が実現される保証が無いことを心に留めておいてください。


* あなたの見つけたバグが本当にバグかどうか、つまり動くべき機能が動かないことを確認してください。
# '''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ː
 あなたがわからない場合は、ためらわずに [http://forum.freecadweb.org/ フォーラム] にこの問題を説明し、何をすればよいか訪ねてください。
# 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].
* 投稿する前に、[[FAQ|frequently asked questions]] を読み、[http://forum.freecadweb.org/ フォーラム] 内を検索し、バグトラッカーを検索して、同じバグがまだ投稿されてないことを確認してください。
# 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.
* あなたが使用しているオペレーティングシステムが32bitか64bitか、 あなたが使っているFreeCADのバージョンについての情報を付け加えてください。
* '''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]]
* FreeCADをinux上で利用し、バグが原因でクラッシュした場合は、デバッグトレースを実行することもできます。端末からgdb freecadを実行(gdbパッケージがインストールされていることを仮定)し、gdbの中でrunを実行します。 FreeCADは実行されます。クラッシュが発生したら、btと入力するとバックトレースを取得できます。投稿するバグレポートの中にバックトレースを含めてください。


<span id="Submitting_patches"></span>
== パッチの投稿 ==
== パッチの投稿 ==


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'').
In case you have programmed a bug fix, an extension or something else that can be of public use in FreeCAD, submit your patch as a "Pull Request" at [https://github.com/FreeCAD/FreeCAD GitHub].
# For a large, complex, or behavior-changing submission, open a forum thread in the [https://forum.freecadweb.org/viewforum.php?f=10 Developer subforum] to announce and discuss your patch. For small bugfixes this is not necessary.
# Submit your Pull Request (PR) to the [http://github.com/FreeCAD/FreeCAD FreeCAD GitHub repo]. The PR submission message will be pre-filled with a checklist for you to follow to ensure that your submission has the best chance at speedy acceptance. If you haven't worked with {{incode|git}} before or are unfamiliar with submitting a PR to github, please read our introduction to [[Source_code_management|github]] wiki page.
# Be present for the discussion, both in the forum and in the GitHub pull request, so that your code can potentially be merged more effectively.

<span id="Requesting_merge"></span>
== "古い"sourceforgeのトラッカー(廃止) ==

注意:バグを報告するために、新しいMantisバグトラッカーを利用してください。この方法は現在廃止予定です。


=== どこで見つけるか? ===
Addendumː FreeCAD development has switched to the [https://github.com/FreeCAD/FreeCAD GitHub] development model so the workflow for submitting patches has been greatly enhanced/streamlined by submitting Pull Requests.
FreeCADには独自の [https://sourceforge.net/tracker/?group_id=49159 トラッカー要約ページ] があります。そこではトラッカーの個々のセクションの概要を見ることができます。
* Open a forum thread in the Developer subforum to announce and discuss your patch.
* Submit your PR to the [http://github.com/FreeCAD/FreeCAD FreeCAD GitHub repo]. Be sure to link the forum thread in to the git commit summary.
* Paste the PR link in to the forum thread for the devs/testers to test.
* Be present for the discussion so that your code can potentially be merged more effectively.
'''NOTEː''' the FreeCAD community recommends to first discuss any large revision to the source code in advance to save everyone time.


=== いつ使用するか? ===
== Requesting merge ==
[[Image:Bugtracker Screenshot annotated.png|right|thumb|The FreeCAD Bug Tracker]]


(Same guidelines as [https://www.freecadweb.org/wiki/Tracker#Submitting_patches Submiting patches])
(Same guidelines as [https://www.freecadweb.org/wiki/Tracker#Submitting_patches Submiting patches])
Line 70: Line 86:
== MantisBT Tips and Tricks ==
== MantisBT Tips and Tricks ==


近年、sourceforgeプラットフォームにより、プロジェクトのバグトラッカーアプリケーション[http://www.mantisbt.org/ mantis bug tracker] が作られ、FreeCADは、古いビルトインのバグトラッカーの代わりに、現在このバグトラッカーを使っています。
=== 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 ===
=== MantisBT BBCode ===
In addition to the above [[Tracker/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ː
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 />
<small><code><br />
[img][/img] - Images <br />
[img][/img] - Images <br />
Line 118: Line 122:
</code>
</code>
</small>
</small>

=== MantisBT <=> GitHub Markup ===
=== MantisBT <=> GitHub Markup ===
Below are special MantisBT Source-Integration plugin keywords which will link to the FreeCAD GitHub repo. See [[Tracker#GitHub_and_MantisBT]].
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>
* '''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>
* '''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>
Line 131: Line 136:
'''Note''' The below keywords need to be added in the <u>git commit message</u> and not the PR subject
'''Note''' The below keywords need to be added in the <u>git commit message</u> and not the PR subject


=== Attaching a git commit to a ticket ===
=== 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:
The format MantisBT will recognize:
* bug #1234
* bug #1234
Line 157: Line 163:
<code>/(?:fixe?d?s?|resolved?s?)+\s*:?\s+(?:#(?:\d+)[,\.\s]*)+/i</code></small>
<code>/(?:fixe?d?s?|resolved?s?)+\s*:?\s+(?:#(?:\d+)[,\.\s]*)+/i</code></small>


== Related ==
* [[Bug Triage]]
* [[Source Code Management]]


<div class="mw-translate-fuzzy">
{{docnav|Licence|Bug Triage}}
{{docnav|Licence|Bug Triage}}
</div>


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

{{clear}}

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

もし、バグを発見したかもと思ったら、そこにバグを報告することは歓迎されます。しかし、バグを報告する前に、以下の項目をチェックしてください。:

  • あなたの見つけたバグが本当にバグかどうか、つまり動くべき機能が動かないことを確認してください。

 あなたがわからない場合は、ためらわずに フォーラム にこの問題を説明し、何をすればよいか訪ねてください。

  • 投稿する前に、frequently asked questions を読み、フォーラム 内を検索し、バグトラッカーを検索して、同じバグがまだ投稿されてないことを確認してください。
  • できるだけ詳しく、問題や再現方法について説明してください。バグを確認できない場合、修正できなことがあります。
  • あなたが使用しているオペレーティングシステムが32bitか64bitか、 あなたが使っているFreeCADのバージョンについての情報を付け加えてください。
  • バグ毎に個別のレポートを投稿してください。
  • FreeCADをinux上で利用し、バグが原因でクラッシュした場合は、デバッグトレースを実行することもできます。端末からgdb freecadを実行(gdbパッケージがインストールされていることを仮定)し、gdbの中でrunを実行します。 FreeCADは実行されます。クラッシュが発生したら、btと入力するとバックトレースを取得できます。投稿するバグレポートの中にバックトレースを含めてください。


フローチャート

上記のフローチャートに示されているように、チケットを作成する前にまずフォーラムとバグトラッカーを検索して、問題が既知の問題で あるかどうかを確認してください。 これにより、開発者やボランティアにとって、FreeCADをさらにすばらしいものにする時間を節約できます。

バグ

もし、バグを発見したかもと思ったら、そこにバグを報告することは歓迎されます。しかし、バグを報告する前に、以下の項目をチェックしてください。:


もしバグを発見したかもしれないと思う場合は、トラッカーの Bugs Section に行き、statusをanyにして、これまでに申請されたバグを確認してください。キーワード検索を利用すると、似ている問題のバグトラッカーのエントリを見つけることができます。もし、あなたの問題が過去の項目になかったときは、同じページに新たな項目として投稿すべきです。

機能追加要求

あなたがFreeCADを世界で一番のCADソフトウェアにするために絶対に必要と思う機能がないことに気づいたら、Feature Request 機能追加要望のセクションが役に立つかもしれません。

サポート要求

あなたがFreeCADをコンパイルするのにどうすることもできず、 Compile on WindowsCompile on Linux にヒントとなるものが書かれていない場合や、他の新しい環境への移植を試す場合や、FreeCADの新しいモジュールや拡張機能を作る場合に、補助が必要な場合は、Support Requests セクションがあなたの行くべき場所になります。

新しいパッチ

バグの修正や、拡張機能、一般公開できるFreeCADの何らかを作成したときは、Subversioを使ってパッチを作成し、 patches section セクションにファイルを投稿してください。

機能追加要望

実装されていない機能をFreeCADで使いたいと思ったら、それはバグではなく、機能追加要望です。これは同じトラッカー(バグではなく機能要望として申請する)に投稿できますが、あなたの機能追加要望が実現される保証が無いことを心に留めておいてください。

  • あなたの見つけたバグが本当にバグかどうか、つまり動くべき機能が動かないことを確認してください。

 あなたがわからない場合は、ためらわずに フォーラム にこの問題を説明し、何をすればよいか訪ねてください。

  • 投稿する前に、frequently asked questions を読み、フォーラム 内を検索し、バグトラッカーを検索して、同じバグがまだ投稿されてないことを確認してください。
  • できるだけ詳しく、問題や再現方法について説明してください。バグを確認できない場合、修正できなことがあります。
  • あなたが使用しているオペレーティングシステムが32bitか64bitか、 あなたが使っているFreeCADのバージョンについての情報を付け加えてください。
  • バグ毎に個別のレポートを投稿してください。
  • FreeCADをinux上で利用し、バグが原因でクラッシュした場合は、デバッグトレースを実行することもできます。端末からgdb freecadを実行(gdbパッケージがインストールされていることを仮定)し、gdbの中でrunを実行します。 FreeCADは実行されます。クラッシュが発生したら、btと入力するとバックトレースを取得できます。投稿するバグレポートの中にバックトレースを含めてください。

パッチの投稿 

In case you have programmed a bug fix, an extension or something else that can be of public use in FreeCAD, submit your patch as a "Pull Request" at GitHub.

  1. For a large, complex, or behavior-changing submission, open a forum thread in the Developer subforum to announce and discuss your patch. For small bugfixes this is not necessary.
  2. Submit your Pull Request (PR) to the FreeCAD GitHub repo. The PR submission message will be pre-filled with a checklist for you to follow to ensure that your submission has the best chance at speedy acceptance. If you haven't worked with git before or are unfamiliar with submitting a PR to github, please read our introduction to github wiki page.
  3. Be present for the discussion, both in the forum and in the GitHub pull request, so that your code can potentially be merged more effectively.

"古い"sourceforgeのトラッカー(廃止)

注意:バグを報告するために、新しいMantisバグトラッカーを利用してください。この方法は現在廃止予定です。

どこで見つけるか?

FreeCADには独自の トラッカー要約ページ があります。そこではトラッカーの個々のセクションの概要を見ることができます。

いつ使用するか?

The FreeCAD Bug Tracker

(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

近年、sourceforgeプラットフォームにより、プロジェクトのバグトラッカーアプリケーションmantis bug tracker が作られ、FreeCADは、古いビルトインのバグトラッカーの代わりに、現在このバグトラッカーを使っています。

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


Licence
Bug Triage