GitHub: Add text to readme and the issue template to record macros for bugs (#15761)
* Add text to readme and the issue template that the user should record a macro when recreating the issue and sharing this macro in the issue. Updated old links from master branch to main.
This commit is contained in:
16
.github/ISSUE_TEMPLATE/PROBLEM_REPORT.yml
vendored
16
.github/ISSUE_TEMPLATE/PROBLEM_REPORT.yml
vendored
@@ -1,12 +1,12 @@
|
|||||||
name: Report a Problem
|
name: Report a Problem
|
||||||
description: Have you found something that does not work well, is too hard to do or is missing altogether? Please create a Problem Report.
|
description: Have you found something that does not work well, is too hard to do or is missing altogether? Please create a Problem Report.
|
||||||
labels: ["needs triage"]
|
labels: ["Status: Needs triage"]
|
||||||
body:
|
body:
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
id: existing_issue
|
id: existing_issue
|
||||||
attributes:
|
attributes:
|
||||||
label: Is there an existing issue for this?
|
label: Is there an existing issue for this?
|
||||||
description: Please search to see if an issue already exists for the problem you encountered.
|
description: Please [search](https://github.com/FreeCAD/FreeCAD/issues) to see if a similar issue already exists for the problem you encountered.
|
||||||
options:
|
options:
|
||||||
- label: I have searched the existing issues
|
- label: I have searched the existing issues
|
||||||
required: true
|
required: true
|
||||||
@@ -14,7 +14,7 @@ body:
|
|||||||
id: description
|
id: description
|
||||||
attributes:
|
attributes:
|
||||||
label: Problem description
|
label: Problem description
|
||||||
description: Describe the problem and how it impacts user experience, workflow, maintainability or speed of the code. If the problem appears to be a bug with the current functionality, provide as test case or recipe that reproduces the error.
|
description: Describe the problem and how it impacts user experience, workflow, maintainability or speed of the code. If the problem appears to be a bug with the current functionality, provide as test case or recipe that reproduces the error. Ideally record a macro and attach it.
|
||||||
placeholder: Description of the problem
|
placeholder: Description of the problem
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
@@ -33,14 +33,13 @@ body:
|
|||||||
options:
|
options:
|
||||||
- Addon Manager
|
- Addon Manager
|
||||||
- Assembly
|
- Assembly
|
||||||
- BIM/Arch
|
- BIM
|
||||||
- CAM/Path
|
- CAM
|
||||||
- Core
|
- Core
|
||||||
- Draft
|
- Draft
|
||||||
- Expressions
|
- Expressions
|
||||||
- FEM
|
- FEM
|
||||||
- File formats
|
- File formats
|
||||||
- GCS
|
|
||||||
- Mesh
|
- Mesh
|
||||||
- OpenSCAD
|
- OpenSCAD
|
||||||
- Part
|
- Part
|
||||||
@@ -48,7 +47,7 @@ body:
|
|||||||
- Project Tools & Websites
|
- Project Tools & Websites
|
||||||
- Sketcher
|
- Sketcher
|
||||||
- Spreadsheet
|
- Spreadsheet
|
||||||
- Techdraw
|
- TechDraw
|
||||||
- Other (specify in description)
|
- Other (specify in description)
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: anything_else
|
id: anything_else
|
||||||
@@ -57,6 +56,7 @@ body:
|
|||||||
description: |
|
description: |
|
||||||
Links? References? Anything that will give us more context about the issue you are encountering!
|
Links? References? Anything that will give us more context about the issue you are encountering!
|
||||||
If there is a discussion about the problem on the forum, provide link(s) here.
|
If there is a discussion about the problem on the forum, provide link(s) here.
|
||||||
|
You can upload or copy your macro here to speed up the diagnosis and debugging.
|
||||||
|
|
||||||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. To attach a FCStd file, ZIP it first (GitHub won't recognize the extension otherwise).
|
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. To attach a FCStd file, ZIP it first (GitHub won't recognize the extension otherwise).
|
||||||
validations:
|
validations:
|
||||||
@@ -65,7 +65,7 @@ body:
|
|||||||
id: terms
|
id: terms
|
||||||
attributes:
|
attributes:
|
||||||
label: Code of Conduct
|
label: Code of Conduct
|
||||||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/FreeCAD/FreeCAD/blob/master/CODE_OF_CONDUCT.md)
|
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/FreeCAD/FreeCAD/blob/main/CODE_OF_CONDUCT.md)
|
||||||
options:
|
options:
|
||||||
- label: I agree to follow this project's Code of Conduct
|
- label: I agree to follow this project's Code of Conduct
|
||||||
required: true
|
required: true
|
||||||
|
|||||||
13
README.md
13
README.md
@@ -78,18 +78,19 @@ Reporting Issues
|
|||||||
|
|
||||||
To report an issue please:
|
To report an issue please:
|
||||||
|
|
||||||
- First post to forum to verify the issue;
|
- Consider posting to the [Forum](https://forum.freecad.org), [Discord](https://discord.com/invite/F4hdxzYZfc) channel, or [Reddit](https://www.reddit.com/r/FreeCAD) to verify the issue;
|
||||||
- Link forum thread to bug tracker ticket and vice-a-versa;
|
- Search the existing [issues](https://github.com/FreeCAD/FreeCAD/issues) for potential duplicates;
|
||||||
- Use the most updated stable or development versions of FreeCAD;
|
- Use the most updated stable or [development versions](https://github.com/FreeCAD/FreeCAD-Bundle/releases/tag/weekly-builds) of FreeCAD;
|
||||||
- Post version info from eg. `Help > About FreeCAD > Copy to clipboard`;
|
- Post version info from e.g. `Help > About FreeCAD > Copy to clipboard`;
|
||||||
|
- Start recording a macro `Macro > Macro recording...` and repeat all steps. Stop recording after the issue occurs and upload the saved macro or copy the macro code in the issue;
|
||||||
- Post a Step-By-Step explanation on how to recreate the issue;
|
- Post a Step-By-Step explanation on how to recreate the issue;
|
||||||
- Upload an example file to demonstrate problem.
|
- Upload an example file (FCStd as ZIP file) to demonstrate the problem;
|
||||||
|
|
||||||
For more detail see:
|
For more detail see:
|
||||||
|
|
||||||
- [Bug Tracker](https://github.com/FreeCAD/FreeCAD/issues)
|
- [Bug Tracker](https://github.com/FreeCAD/FreeCAD/issues)
|
||||||
- [Reporting Issues and Requesting Features](https://github.com/FreeCAD/FreeCAD/issues/new/choose)
|
- [Reporting Issues and Requesting Features](https://github.com/FreeCAD/FreeCAD/issues/new/choose)
|
||||||
- [Contributing](https://github.com/FreeCAD/FreeCAD/blob/master/CONTRIBUTING.md)
|
- [Contributing](https://github.com/FreeCAD/FreeCAD/blob/main/CONTRIBUTING.md)
|
||||||
- [Help Forum](https://forum.freecad.org/viewforum.php?f=3)
|
- [Help Forum](https://forum.freecad.org/viewforum.php?f=3)
|
||||||
- [Developers Handbook](https://freecad.github.io/DevelopersHandbook/)
|
- [Developers Handbook](https://freecad.github.io/DevelopersHandbook/)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user