From eb4e641e7f856c7471ffd0ecc88caed34b5a72a4 Mon Sep 17 00:00:00 2001 From: Ryan White Date: Mon, 7 Dec 2020 11:38:23 -0800 Subject: [PATCH 1/2] Update README.md Added details on reporting issues to the README.md file --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 906233ee8a..c815e093b5 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,24 @@ The pages below contain up-to-date build instructions: - [Cygwin](https://wiki.freecadweb.org/Compile_on_Cygwin) - [MinGW](https://wiki.freecadweb.org/Compile_on_MinGW) + +Reporting Issues +--------- + +To report an issue please: +- First post to forum to verify the issue; +- Link forum thread to bug tracker ticket and vice-a-versa; +- Use the most updated stable or development versions of FreeCAD; +- Post version info from eg. Help>About FreeCAD>Copy to clipboard; +- Post a Step-By-Step explanation on how to recreate the issue; +- Upload an example file to demonstrate problem. + +For more detail see: +- [Wiki Page about the Bug Tracker](https://wiki.freecadweb.org/Tracker) +- [Bug Tracker](https://www.freecadweb.org/tracker/) +- [Help Forum](http://forum.freecadweb.org/viewforum.php?f=3) + + Usage & Getting help -------------------- From 91a2b0495fe81e84a100f68b3ba075e8f48a923b Mon Sep 17 00:00:00 2001 From: Ryan White Date: Thu, 10 Dec 2020 00:52:46 -0800 Subject: [PATCH 2/2] Update README.md Updated per comments on first PR --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c815e093b5..9e33c68f29 100644 --- a/README.md +++ b/README.md @@ -95,13 +95,13 @@ To report an issue please: - First post to forum to verify the issue; - Link forum thread to bug tracker ticket and vice-a-versa; - Use the most updated stable or development versions of FreeCAD; -- Post version info from eg. Help>About FreeCAD>Copy to clipboard; +- Post version info from eg. `Help > About FreeCAD > Copy to clipboard`; - Post a Step-By-Step explanation on how to recreate the issue; - Upload an example file to demonstrate problem. For more detail see: - [Wiki Page about the Bug Tracker](https://wiki.freecadweb.org/Tracker) -- [Bug Tracker](https://www.freecadweb.org/tracker/) +- [Bug Tracker](https://tracker.freecadweb.org) - [Help Forum](http://forum.freecadweb.org/viewforum.php?f=3)